DELETE /platform/v1/key/{keyId}
Deletes a key based on the keyId for the current MID. This feature isn't enabled by default for most accounts. Contact your Account Executive for more information about enabling this feature. To use this feature, Data at Rest Encryption must be enabled for your account.
Name | Type | Description | |
---|---|---|---|
keyId | string | Required | ID of the key. Format: UUID. |
x-request-id | string | Header parameter: Request ID for the request. Default Format: 4586c4c7-8504-4cf4-942d-19f99a57c4d9. | |
x-mccs-user-context | string | Header parameter: Indicates the MCCS user context. Example: EID=111;MID=111;EmployeeId=111. | |
x-mccs-keystore-provider | string | Header parameter: Specify a key store provider to use for an ImportKey or WrappingKey request. Examples: kms, keysecure, database. Default: keysecure. | |
x-mccs-mac | string | Header parameter: Specify the message authentication code for the request. |
Status | Name | Type | Description |
---|---|---|---|
204 | Successfully soft deleted meta data and hard deleted key from keystore | ||
400 | Tde keys used by encrypted backups can’t be deleted, must wait 90 days from rotate or restore | ||
type | string | undefined | |
title | string | undefined | |
status | integer | Format: int32. | |
detail | string | undefined | |
instance | string | undefined | |
additionalProperties | object | undefined | |
404 | Key not found | ||
type | string | undefined | |
title | string | undefined | |
status | integer | Format: int32. | |
detail | string | undefined | |
instance | string | undefined | |
additionalProperties | object | undefined | |
500 | Unable to process request | ||
statusCode | integer | Format: int32. | |
requestId | string | undefined | |
message | string | undefined | |
messageCode | string | undefined |
To delete a key, send a DELETE request to the /platform/v1/key/{keyID}
When the key is deleted, the system responds with an HTTP 204 code.