Start Rotation Job

Available in VPC

Start a secret rotation job. Secret Manager is notified that the rotation job has started, and the secret's rotation status changes to Rotation in progress.

Request

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

Method	URI
POST	/action/v1/secrets/{secretId}/jobs/{jobToken}/start

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 See Get Secret List or Get Secret Logs. Automatically injected into the application that fired the trigger, visible as an environment variable. See Secret rotation action example code.
`jobToken`	String	Required	Job token See Get Secret Logs. Automatically injected into the application that fired the trigger, visible as an environment variable. See Secret rotation action example code.

Request example

The request example is as follows:

curl --location --request POST 'https://secretmanager.apigw.ntruss.com/action/v1/secrets/{secretId}/jobs/{jobToken}/start' \
--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.decryptedSecretChain`	Object	-	Decrypted secret chain
`data.decryptedSecretChain.previous`	String	-	Previously used decrypted secret value (PREVIOUS stage) based on ACTIVE stage
`data.decryptedSecretChain.active`	String	-	Decrypted active secret value (ACTIVE stage) currently in normal use
`data.decryptedSecretChain.pending`	String	-	Decrypted secret value (PENDING stage) whose rotation has started anew and is 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": {
        "decryptedSecretChain": {
            "previous": "{\"abc\":\"cba\"}",
            "active": "{\"abc\":\"{cba\"}",
            "pending": "{\"abc\":\"{cba\"}"
        },
        "rotationTargets": [
            "abc"
        ]
    }
}