Update Secret Stage Value

Prev Next

Available in VPC

Edit the secret value of a secret stage. The value of a secret in the REVOKE (deletion requested) can't be changed.

Request

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

Method URI
PUT /api/v1/secrets/{secretId}/values/{secret-value-stage}

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
secret-value-stage String Required Secret stage
  • previous | active | pending
    • previous: PREVIOUS stage (previously used secrets based on the ACTIVE stage)
    • active: ACTIVE stage (active secrets that are currently in normal use)
    • pending: PENDING stage (secrets whose rotation has started anew and are waiting for the rotation to complete)

Request body

You can include the following data in the body of your request:

Field Type Required Description
value String Required Secret value

Request example

The request example is as follows:

curl --location --request PUT 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/values/previous' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "value": "{\"abc\":\"cba\"}"
}'

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.encryptedSecretValue Object - Encrypted secret value information
data.encryptedSecretValue.value String - Encrypted secret value
data.encryptedSecretValue.valueStage String - Secret stage
  • previous | active | pending
    • previous: PREVIOUS stage (previously used secrets based on the ACTIVE stage)
    • active: ACTIVE stage (active secrets that are currently in normal use)
    • pending: PENDING stage (secrets whose rotation has started anew and are waiting for the rotation to complete)

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": {
        "encryptedSecretValue": {
            "value": "ncpkms:v1:*****0ObO7xznMJWUptMNLK/IZsEbp+****+6wRDfCcQW93r5FfG****",
            "valueStage": "PREVIOUS"
        }
    }
}