Secret Manager overview

Prev Next

Available in VPC

Secret Manager is a NAVER Cloud Platform service that allows you to securely manage security passwords. The Secret Manager service provides APIs related to creating, retrieving, replacing, and deleting security passwords in RESTful form.

Common Secret Manager settings

The following describes commonly used request and response formats in Secret Manager APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://secretmanager.apigw.ntruss.com

Request headers

The following describes the request headers.

Field Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
  • Unix timestamp format.
x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256).
Content-Type Optional Request data format
  • application/json

Response

The following describes the common response format.

Response body

The response body includes the following data:

responseError
responseError defines the API call failure information. The following describes responseError.

Field Type Required Description
error Object - Error information
error.errorCode String - Error code
error.message String - Error message
error.details String - Error details

Response status codes

The following describes the response status codes.

HTTP status code Code Message Description
403 FORBIDDEN Forbidden Request denied with completed authentication or no authorization
500 INTERNAL_SERVER_ERROR Server internal error Internal server errors
422 UNPROCESSABLE_ENTITY Invalid status Request is valid but violates a rule.
400 INVALID_REQUEST Invalid request Invalid request
401 UNAUTHORIZED Unauthorized Missing authentication information
404 NOT_FOUND Not found No requested resource
409 INVALID_STATUS Invalid status Invalid status value
Note

For information about the HTTP status codes common to all NAVER Cloud Platform, see Ncloud API response status codes.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

{
  "error": {
    "errorCode": "string",
    "message": "string",
    "details": "string"
  }
}

Secret Manager API

This section describes the APIs provided by the Secret Manager service.

API Description
Create Secret Create secret.
Get Protection Key List Get protection key list.
Get Secret Detail Get secret details.
Get Secret List Get secret list.
Get Secret Logs Get secret usage log.
Get Secret Stage Value Get secret value of a specific secret stage.
Get Secret Value Get secret value.
Get Trigger List Get the list of triggers.
Cancel Rotation Job Cancel a running secret replacement job.
Cancel Secret Deletion Cancel secret deletion request.
Disable Auto Rotation Disable security auto rotation.
Disable Secret Disable secret.
Enable Auto Rotation Enable secret auto rotation.
Enable Secret Enable secret.
Execute Rotation Job Run secret rotation job.
Request Secret Deletion Create secret deletion request.
Retry Rotation Job Retry secret rotation job.
Rollback Rotation Job Rollback secret rotation job.
Update Protection Key Change protection key.
Update Rotation Period Change secret rotation cycle.
Update Rotation Trigger Change secret rotation trigger.
Update Secret Memo Edit secret description.
Update Secret Stage Value Edit secret value of a specific secret stage.
Update Secret Value Change secret value of all secret stages.
Delete Rotation Trigger Delete secret rotation trigger.
Delete Secret Delete secret.

Secret Rotate Process Control

The following describes the APIs related to secret rotate process control.

API Description
Add Pending Stage Create pending stage
Generate Random Secret Generate random secret string.
Complete Rotation Job Notify secret rotation job completion.
Fail Rotation Job Notify secret rotation job failure.
Start Rotation Job Start secret rotation job.
Update Pending Stage Edit secret value of a pending stage.

Secret Manager related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Secret Manager APIs.