Enable Auto Rotation

Prev Next

Available in VPC

Enable automatic rotation of a secret.

Request

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

Method URI
POST /api/v1/secrets/{secretId}/enable-auto-rotation

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 body

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

Field Type Required Description
rotationPeriod Integer Optional Secret automatic rotation cycle (day)
  • 1-730 (default: 90)
triggerId String Conditional Trigger ID
  • Required if no triggers are connected or you want to change them.
  • See Get Trigger List.

Request example

The request example is as follows:

curl --location --request POST 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/enable-auto-rotation' \
--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 '{
    "rotationPeriod": 90,
    "triggerId": "*****"
}'

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.autoRotationYN String - Whether to rotate automatically
  • Y: Rotate automatically (valid value)
data.autoRotationPeriod Integer - Secret automatic rotation cycle (day)
data.nextRotationDate Long - Next scheduled rotation date and time (millisecond)
  • Unix timestamp format
data.trigger Object - Information of the trigger
data.trigger.id String - Trigger ID
data.trigger.name String - Trigger name
data.trigger.url String - Trigger URL
data.trigger.recentlyExecutedAction String - Recently executed action
  • Displayed if there is a history of actual actions taken

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*****",
        "autoRotationYN": "Y",
        "autoRotationPeriod": 90,
        "nextRotationDate": 1761015600000,
        "trigger": {
            "id": "*****",
            "name": "test",
            "url": "https://console.ncloud.com/vpcCloudFunctions/trigger/detail/test"
        }
    }
}