PSImmich

Author(s)

• Hannes Palmquist

Tags

Windows Linux MacOS

Functions

Add-IMActivity Get-IMActivity Get-IMActivityStatistic Remove-IMActivity Add-IMAlbumUser Get-IMAlbum Get-IMAlbumStatistic New-IMAlbum Remove-IMAlbum Remove-IMAlbumUser Rename-IMAlbum Set-IMAlbum Set-IMAlbumUser Get-IMAPIKey New-IMAPIKey Remove-IMAPIKey Rename-IMAPIKey Export-IMAssetThumbnail Get-IMAsset Get-IMAssetStatistic Import-IMAsset Remove-IMAsset Restore-IMAsset Save-IMAsset Set-IMAsset Start-IMVideoTranscode Update-IMAssetMetadata Update-IMAssetThumbnail Test-IMAccessToken Get-IMAuthSession Remove-IMAuthSession Get-IMDuplicate Get-IMFace Clear-IMJob Get-IMJob Resume-IMJob Start-IMJob Suspend-IMJob Get-IMLibrary New-IMLibrary Remove-IMLibrary Set-IMLibrary Sync-IMLibrary Test-IMLibrary Convert-IMCoordinatesToLocation Get-IMMapMarker Get-IMMemory New-IMMemory Remove-IMMemory Set-IMMemory Send-IMTestMessage Add-IMPartner Get-IMPartner Remove-IMPartner Set-IMPartner Export-IMPersonThumbnail Get-IMPerson Merge-IMPerson New-IMPerson Set-IMPerson Get-IMPlugin Find-IMAsset Find-IMCity Find-IMExploreData Find-IMPerson Find-IMPlace 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 New-IMUser Remove-IMMyProfilePicture Remove-IMUser Restore-IMUser Set-IMUser Set-IMUserPreference Get-IMWorkflow New-IMWorkflow Remove-IMWorkflow Set-IMWorkflow

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

## [2.3.0-preview0009] - 2025-11-22

### BREAKING CHANGES

- Get-IMServer* cmdlets have been removed and replaced by a single Get-IMServer cmdlet that provides switch parameters for the different data.
 - Removed cmdlets
   - Get-IMServerAbout -> Get-IMServer -About
   - Get-IMServerConfig -> Get-IMServer -Configuration
   - Get-IMServerFeature -> Get-IMServer -Features
   - Get-IMServerStatistic -> Get-IMServer -Statistics
   - Get-IMServerStorage -> Get-IMServer -Storage
   - Get-IMServerVersion -> Get-IMServer -Version & Get-IMServer -VersionHistory
   - Get-IMServerMediaTypes -> Get-IMServer -MediaTypes
   - Get-IMTheme -> Get-IMServer -Theme
   - Get-IMConfig -Applied -> Get-IMServer -AppliedSystemConfiguration
   - Get-IMConfig -Default -> Get-IMServer -DefaultSystemConfiguration
   - Get-IMConfig -Storage -> Get-IMServer -StorageTemplateOptions
   - Test-IMPing -> Get-IMServer -Ping
   - Set-IMConfig -RawJson -> Set-IMServer -RawJson

### Added

- New Plugin management cmdlets (Alpha feature):
 - Get-IMPlugin - Retrieve plugins with support for listing all plugins or getting specific plugin by ID
- New Workflow management cmdlets (Alpha feature):
 - NOTE: These are basically untested, the API specification is not complete and workflows are currently under active development by the Immich Team. These cmdlets has been added as a preparation for when the workflow feature is stable.
 - Get-IMWorkflow - Retrieve workflows with support for listing all workflows or getting specific workflow by ID
 - New-IMWorkflow - Create new workflows with configurable name, description, trigger type, actions, and filters
 - Set-IMWorkflow - Update existing workflows including name, description, trigger type, enabled state, actions, and filters
 - Remove-IMWorkflow - Delete workflows with confirmation support
- New server info
 - Get-IMServer -APKLinks
 - Get-IMServer -VersionCheck

### Changed

- Enhanced Memory management functionality:
 - Get-IMMemory - Added support for retrieving memories statistics via new -Statistics parameter
 - Get-IMMemory - New parameters: Order, For, NumberOfMemories, IsSaved, IsTrashed, Type, Statistics
 - Get-IMMemory - Integrated /memories/statistics API functionality
- Updated Job management:
 - Start-IMJob - Now uses the updated POST /jobs API endpoint
- Updated Partner cmdlets for API changes
- Deprecated functionality removal:
 - Get-IMAsset - Removed DeviceID support following API deprecation