Disable Secret

Available in VPC

Suspend the use of a secret. Only secrets in the ENABLE (available) status can be suspended.

Request

This section describes the request format. The method and URI are as follows:

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:

Request example

The request example is as follows:

curl --location --request POST 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/disable' \
--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:

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": 1753165313617
    }
}