- Print
- PDF
Request Key Deletion
- Print
- PDF
Available in Classic and VPC
Request deletion of a key. Upon request, the key will be changed to the status of Pending deletion, and will be automatically deleted finally after a 72-hour wait.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /keys/{keyTag}/request-deletion |
Request headers
For information about the headers common to all Key Management Service APIs, see the account authentication method in Key Management Service request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
keyTag | String | Required | Key tag
|
Request example
The request example is as follows:
curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/request-deletion' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
code | String | - | Success or Failure |
data | Object | - | Response result |
data.keyTag | String | - | Tag of the key whose deletion was requested |
data.status | String | - | Key status
|
data.statusDate | Long | - | Date and time when the key was requested to be deleted (millisecond)
|
Response status codes
For response status codes common to all Key Management Service APIs, see Key Management Service response status codes.
Response example
The response example is as follows:
{
"code": "SUCCESS",
"data": {
"keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"status": "REVOKE",
"statusDate": 1733468239421
}
}