Available in VPC
Register a pending stage value. Unlike Add Pending Stage, which automatically populates a value for the secret rotation and registers it as a pending stage, you can specify a value manually. You can also use Generate Random Secret to register with a value that is generated based on the desired criteria.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
PUT | /action/v1/secrets/{secretId}/jobs/{jobToken}/pending |
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
|
jobToken |
String | Required | Job token
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
value |
String | Required | Secret value
|
Request example
The request example is as follows:
curl --location --request PUT 'https://secretmanager.apigw.ntruss.com/action/v1/secrets/{secretId}/jobs/{jobToken}/pending' \
--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-raw '{
"value": "{\"abc\":\"2!?xY\"}"
}'
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.pending |
String | - | Registered Pending stage secret value |
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": {
"pending": "{\"abc\":\"2!?xY\"}"
}
}