Skip to main content

Remove-IMAPIKey

SYNOPSIS​

Removes Immich API keys

SYNTAX​

Remove-IMAPIKey [[-Session] <ImmichSession>] [-Id] <String[]> [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION​

Removes one or more API keys from the Immich server. This action is permanent and cannot be undone. Any applications using the removed API keys will lose access immediately.

EXAMPLES​

EXAMPLE 1​

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

Removes the specified API key with confirmation prompt.

EXAMPLE 2​

Get-IMAPIKey | Where-Object {$_.name -like 'Old*'} | Remove-IMAPIKey

Removes all API keys with names starting with 'Old'.

EXAMPLE 3​

Remove-IMAPIKey -Id 'key-uuid' -Confirm:$false

Removes the API key without confirmation prompt.

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: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

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

Type: String[]
Parameter Sets: (All)
Aliases:

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

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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​

This cmdlet supports ShouldProcess and will prompt for confirmation before removing API keys.

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