PSImmich

3.4.0

Powershell wrapper for the Immich API

Minimum PowerShell version

5.1

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name PSImmich -RequiredVersion 3.4.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name PSImmich -Version 3.4.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) Hannes Palmquist. All rights reserved.

Package Details

Author(s)

  • Hannes Palmquist

Tags

Windows Linux MacOS

Functions

Add-IMActivity Get-IMActivity Get-IMActivityStatistic Remove-IMActivity Add-IMAlbumUser Get-IMAlbum Get-IMAlbumMapMarker Get-IMAlbumStatistic New-IMAlbum Remove-IMAlbum Remove-IMAlbumUser Rename-IMAlbum Set-IMAlbum Set-IMAlbumUser Get-IMAPIKey New-IMAPIKey Remove-IMAPIKey Rename-IMAPIKey Reset-IMAPIKey Copy-IMAssetInfo Export-IMAssetThumbnail Get-IMAsset Get-IMAssetEdit Get-IMAssetFile Get-IMAssetFolder Get-IMAssetStatistic Import-IMAsset Remove-IMAsset Remove-IMAssetEdit Remove-IMAssetMetadata Restore-IMAsset Save-IMAsset Save-IMAssetFile Set-IMAsset Set-IMAssetEdit Set-IMAssetMetadata Start-IMVideoTranscode Update-IMAssetMetadata Update-IMAssetThumbnail Test-IMAccessToken Get-IMAuthSession Remove-IMAuthSession Get-IMDuplicate Remove-IMDuplicate Resolve-IMDuplicate Get-IMFace New-IMFace Remove-IMFace Set-IMFace Clear-IMJob Get-IMJob Resume-IMJob Start-IMJob Suspend-IMJob Get-IMLibrary New-IMLibrary Remove-IMLibrary Set-IMLibrary Sync-IMLibrary Test-IMLibrary Get-IMDatabaseBackup Get-IMIntegrityReport Get-IMMaintenanceStatus Remove-IMDatabaseBackup Remove-IMIntegrityReport Save-IMDatabaseBackup Save-IMIntegrityReport Start-IMMaintenanceMode Stop-IMMaintenanceMode Convert-IMCoordinatesToLocation Get-IMMapMarker Get-IMMemory New-IMMemory Remove-IMMemory Set-IMMemory New-IMNotification Send-IMTestMessage Add-IMPartner Get-IMPartner Remove-IMPartner Set-IMPartner Get-IMPasskey Remove-IMPasskey Rename-IMPasskey Add-IMPersonAccess Export-IMPersonThumbnail Get-IMPerson Get-IMPersonAccess Merge-IMPerson New-IMPerson Remove-IMPerson Remove-IMPersonAccess Set-IMPerson Get-IMPlugin Get-IMPluginMethod Get-IMPluginTemplate Clear-IMQueue Get-IMQueue Get-IMQueueJob Set-IMQueue Find-IMExploreData Find-IMPerson Find-IMPlace Get-IMTopLargestAsset Search-IMAsset Get-IMServer Get-IMServerLicense Remove-IMServerLicense Set-IMServer Set-IMServerLicense Connect-Immich Disconnect-Immich Get-IMSession Invoke-ImmichMethod Add-IMSharedLinkAsset Get-IMSharedLink New-IMSharedLink Remove-IMSharedLink Remove-IMSharedLinkAsset Set-IMSharedLink Get-IMStack New-IMStack Remove-IMStack Remove-IMStackAsset Set-IMStack Get-IMTag New-IMTag Remove-IMTag Set-IMTag Get-IMTimeBucket Add-IMMyProfilePicture Export-IMProfilePicture Get-IMUser Get-IMUserPreference Get-IMUserSession Get-IMUserStatistic New-IMUser Remove-IMMyProfilePicture Remove-IMUser Restore-IMUser Set-IMUser Set-IMUserPreference Get-IMWorkflow Get-IMWorkflowLog Get-IMWorkflowTrigger New-IMWorkflow Remove-IMWorkflow Set-IMWorkflow

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

### ⚠ BREAKING CHANGES

* **api-key:** Permission values absent from the Immich 3.4 enum, including legacy admin.user and album.addAsset names, are no longer accepted.

* **api:** PublicConfigDto and UserConfigDto no longer contain theme, matching the target API. Their former theme DTO classes are removed.

* **server:** Get-IMServer -Theme now requires permission to read admin configuration on Immich 3.4.

### Features

* **api:** align generated contracts with Immich 3.4 ([fa6e440](https://github.com/hanpq/PSImmich/commit/fa6e440a5229354a3dd2a14c24c2dab229736345))

* **passkey:** manage existing passkeys ([2b9e467](https://github.com/hanpq/PSImmich/commit/2b9e4677fe4d79ef5a6ec8ba253c539e8a1e4d11))

* **server:** expose public configuration ([fbc8594](https://github.com/hanpq/PSImmich/commit/fbc85943a1b892eba6fc6571862ed91180b5b97a))

* **server:** expose server feature level ([abacf5a](https://github.com/hanpq/PSImmich/commit/abacf5a8f5ff3a7b50dc7d0e8642cb5d02335bf8))

* **workflow:** support OCR extraction triggers ([821cee9](https://github.com/hanpq/PSImmich/commit/821cee9262d87bf30fbc2d5870b32cdbd0d96247))

### Bug Fixes

* **api-key:** align permissions with Immich 3.4 ([48e6ff9](https://github.com/hanpq/PSImmich/commit/48e6ff93af48b061be2e4c20b73ca8fc663769e1))

* **asset:** route uploads through the API wrapper ([86d6833](https://github.com/hanpq/PSImmich/commit/86d68336bf5b808fff083ae297e5a9cd4b919d15))

* **coverage:** exclude generated tests from reachability ([dea7754](https://github.com/hanpq/PSImmich/commit/dea7754107951749d129907240a3a3c2da892e1e))

* **docs:** publish module help to the correct site folder ([7e34226](https://github.com/hanpq/PSImmich/commit/7e3422670d2259196c3a677a450cf7989de1f382))

* **server:** retrieve theme from admin configuration ([cba77e4](https://github.com/hanpq/PSImmich/commit/cba77e4ff7e7d3a669e045795ab85875be255aa6))

* trigger beta release ([ffe92ff](https://github.com/hanpq/PSImmich/commit/ffe92ffb89a0b2fac957d9fd32e195bcacfe46f5))

* trigger beta release Release-As: 3.4.0-beta001 ([a2ef741](https://github.com/hanpq/PSImmich/commit/a2ef741bc7d866e39d9482f227635862f2553a01))

FileList

Version History

Version Downloads Last updated
3.4.1 8 11/12/2026
3.4.1-beta001 4 11/12/2026
3.4.0 (current version) 11 11/11/2026
3.4.0-beta001 4 11/11/2026
3.3.7 12 11/9/2026
3.3.7-beta003 4 11/9/2026
3.3.7-beta002 3 11/9/2026
3.3.6-beta001 5 11/9/2026
2.4.0-tags 13 11/25/2025
2.4.0-previe... 7 11/25/2025
2.3.1 216 11/22/2025
2.3.0-tags 7 11/13/2025
2.3.0-previe... 6 11/22/2025
2.3.0-previe... 7 11/21/2025
2.3.0-previe... 6 11/21/2025
2.3.0-previe... 8 11/21/2025
2.3.0-previe... 7 11/17/2025
2.3.0-previe... 6 11/15/2025
2.3.0-previe... 6 11/14/2025
2.3.0-previe... 7 11/13/2025
2.3.0-previe... 8 11/6/2025
2.2.5 23 11/17/2025
2.2.4 14 11/13/2025
2.2.1 14 11/6/2025
2.2.0 14 11/3/2025
1.128.0 100 3/3/2025
1.119.0-prev... 6 3/3/2025
1.118.0 657 10/15/2024
1.118.0-prev... 6 10/15/2024
1.118.0-prev... 7 10/15/2024
1.117.0 14 10/12/2024
1.113.1-prev... 6 10/12/2024
1.113.0 66 9/1/2024
1.111.1 33 8/14/2024
1.107.0 41 7/2/2024
1.106.2-prev... 6 7/2/2024
1.106.1-prev... 7 6/27/2024
1.106.0 138 6/12/2024
1.2.0-previe... 6 6/12/2024
1.1.0 137 3/27/2024
1.0.1-previe... 7 3/27/2024
1.0.0 12 3/20/2024
0.2.0-previe... 8 3/20/2024
0.2.0-previe... 9 3/19/2024
0.2.0-previe... 8 3/18/2024
0.2.0-previe... 9 3/18/2024
0.2.0-previe... 9 3/17/2024
0.2.0-previe... 8 3/17/2024
0.2.0-previe... 8 3/16/2024
0.2.0-previe... 8 3/16/2024
0.2.0-previe... 9 3/16/2024
0.2.0-previe... 9 3/15/2024
0.2.0-previe... 8 3/15/2024
0.2.0-previe... 8 3/15/2024
0.2.0-previe... 9 3/15/2024
0.2.0-previe... 9 3/14/2024
0.2.0-previe... 8 3/14/2024
0.2.0-previe... 9 3/14/2024
0.2.0-previe... 9 3/14/2024
0.2.0-previe... 9 3/13/2024
0.2.0-previe... 9 3/12/2024
0.2.0-previe... 9 3/12/2024
0.2.0-previe... 10 3/12/2024
0.2.0-previe... 8 3/11/2024
0.2.0-previe... 8 3/10/2024
0.1.1-previe... 9 3/10/2024
0.1.1-previe... 11 3/8/2024
0.1.1-previe... 10 3/7/2024
0.1.1-previe... 10 3/7/2024
Show more