Purge Deleted Secret - Purge Deleted Secret

Permanently deletes the specified secret.
The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.

DELETE {vaultBaseUrl}/deletedsecrets/{secret-name}?api-version=7.1

URI Parameters

Name In Required Type Description
secret-name
path True
  • string

The name of the secret.

vaultBaseUrl
path True
  • string

The vault name, for example https://myvault.vault.azure.net.

api-version
query True
  • string

Client API version.

Responses

Name Type Description
204 No Content

No content signaling that the secret was purged forever.

Other Status Codes

Key Vault error response describing why the operation failed.

Examples

PurgeDeletedSecret

Sample Request

DELETE https://myvault.vault.azure.net//deletedsecrets/testsecret?api-version=7.1

Sample Response

Definitions

Error

The key vault server error.

KeyVaultError

The key vault error exception.

Error

The key vault server error.

Name Type Description
code
  • string

The error code.

innererror

The key vault server error.

message
  • string

The error message.

KeyVaultError

The key vault error exception.

Name Type Description
error

The key vault server error.