Fail Rotation Job

Prev Next

Available in VPC

Notify Secret Manager that the secret rotation job failed. The status of the secret's last rotation execution is updated to Rotation failed.

Request

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

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

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 example

The request example is as follows:

curl --location --request POST 'https://secretmanager.apigw.ntruss.com/action/v1/secrets/{secretId}/jobs/{jobToken}/fail' \
--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
  • Display null upon success.

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
}