Skip to content

Remove-DifyAppAPIKey

Warning

This help was primarily created by a generative AI. It may contain partially inaccurate expressions.

SYNOPSIS

Delete the API key of the app.

SYNTAX

Remove-DifyAppAPIKey [[-APIKey] <PSObject[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-DifyAppAPIKey cmdlet deletes API keys associated with a specific app in Dify. You can provide the API keys directly or pipe them as input.

NOTE: This help was primarily created by a generative AI. It may contain partially inaccurate expressions.

EXAMPLES

Example 1

Get-DifyApp -Name "..." | Get-DifyAppAPIKey | Remove-DifyAppAPIKey

Delete the API key, specifying directly from Get-DifyAppAPIKey.

Example 2

$APIKeysToBeRemoved = Get-DifyApp -Name "..." | Get-DifyAppAPIKey
Remove-DifyAppAPIKey -APIKey $APIKeysToBeRemoved

Delete the API key using the result from Get-DifyAppAPIKey.

PARAMETERS

-APIKey

The API key(s) to be removed. This parameter accepts an array of API key objects or can take input from the pipeline.

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

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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: False
Accept pipeline input: False
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: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

System.Management.Automation.PSObject[]

OUTPUTS

System.Object

NOTES