Purge Deleted Key - Purge Deleted Key

Service:

Key Vault

API Version:

7.4

Permanently deletes the specified key.
The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.

DELETE {vaultBaseUrl}/deletedkeys/{key-name}?api-version=7.4

URI Parameters

Name	In	Required	Type	Description
key-name	path	True	string	The name of the key
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 key was permanently purged.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

PurgeDeletedKey

Sample Request

HTTP

DELETE https://myvault.vault.azure.net//deletedkeys/testdeletedkey?api-version=7.4

Sample Response

Status code:

204

Definitions

Name	Description
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	Error	The key vault server error.
message	string	The error message.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.