Available in VPC
Edit the secret automatic rotation cycle.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
PUT | /api/v1/secrets/{secretId}/rotation-period |
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 | Required | Automatic rotation cycle (day) |
Request example
The request example is as follows:
curl --location --request PUT 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/rotation-period' \
--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": 730
}'
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
|
data.autoRotationPeriod |
Integer | - | Secret automatic rotation cycle (day) |
data.nextRotationDate |
Long | - | Next scheduled rotation date and time (millisecond)
|
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": 730,
"nextRotationDate": 1816311600000
}
}