Skip to main content

Get-IMAPIKey

SYNOPSIS​

Retrieves Immich API keys

SYNTAX​

list (Default)​

Get-IMAPIKey [-Session <ImmichSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id​

Get-IMAPIKey [-Session <ImmichSession>] -Id <String[]> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Retrieves one or more API keys from the Immich server. Can retrieve all API keys or specific keys by ID. API keys are used for programmatic access to the Immich API.

EXAMPLES​

EXAMPLE 1​

Get-IMAPIKey

Retrieves all API keys for the current user.

EXAMPLE 2​

Get-IMAPIKey -Id 'bde7ceba-f301-4e9e-87a2-163937a2a3db'

Retrieves a specific API key by its ID.

EXAMPLE 3​

'key1-uuid','key2-uuid' | Get-IMAPIKey

Retrieves multiple API keys by piping their IDs.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID(s) of specific API key(s) to retrieve. Accepts pipeline input and multiple values.

Type: String[]
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github