Available in VPC
Run a trigger by generating a secret rotation event.
Note
When a trigger is executed, a unique job token is automatically generated for the replacement job. The job token can be found in Get Secret Logs.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v1/secrets/{secretId}/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 example
The request example is as follows:
curl --location --request POST 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/rotation' \
--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 |
String | - | Response result
|
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": null
}