Available in VPC
Cancel a secret deletion request. You can only cancel a deletion request with secrets in the REVOKE
(deletion requested) status. If you cancel a secret deletion request, the secret is placed in the DISABLE
(suspended) status, and you can see how to start using it again in Enable Secret.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v1/secrets/{secretId}/cancel-deletion |
Request headers
For information about the headers common to all Secret Manager APIs, see Secret Manager request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
secretId |
String | Required | Secret ID
|
Request example
The request example is as follows:
curl --location --request POST 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/cancel-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 | - | Response code |
data |
Object | - | Response result |
data.secretId |
String | - | Secret ID |
data.secretStatus |
String | - | Secret status
|
data.updateDate |
Long | - | Deletion request cancellation date and time (millisecond)
|
Response status codes
For information about the HTTP status codes common to all Secret Manager APIs, see Secret Manager response status codes.
Response example
The response example is as follows:
{
"code": "SUCCESS",
"data": {
"secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
"secretStatus": "DISABLE",
"updateDate": 1753168087170
}
}