Get Secret Stage Value

Prev Next

Available in VPC

Get the secret value of a secret stage. The value of a secret in the REVOKE (deletion requested) status can't be queried.

Request

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

Method URI
GET /api/v1/secrets/{secretId}/{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 example

The request example is as follows:

curl --location --request GET 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/active' \
--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.decryptedSecretValue Object - Decrypted secret value information
data.decryptedSecretValue.value String - Decrypted secret value
data.decryptedSecretValue.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)
data.rotationTargets Array - List of secret values to be rotated

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": {
        "decryptedSecretValue": {
            "value": "{\"abc\":\"cba\"}",
            "valueStage": "ACTIVE"
        },
        "rotationTargets": [
            "abc"
        ]
    }
}