VPC環境で利用できます。
Pendingステージの値を登録します。シークレットローテーション対象の値を自動で埋めて Pendingステージとして登録するAdd Pending Stageとは違って、値を直接指定できます。さらに、Generate Random Secretを利用すると目的の条件に合わせて作成したシークレット値を登録できます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PUT | /action/v1/secrets/{secretId}/jobs/{jobToken}/pending |
リクエストヘッダ
Secret Manager APIで共通して使用されるヘッダの詳細は、Secret Managerのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
secretId |
String | Required | シークレット ID
|
jobToken |
String | Required | ジョブトークン
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
value |
String | Required | シークレット値
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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\"}"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
code |
String | - | レスポンスコード |
data |
Object | - | レスポンス結果 |
data.pending |
String | - | 登録された Pendingステージのシークレット値 |
レスポンスステータスコード
Secret Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Secret Managerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": "SUCCESS",
"data": {
"pending": "{\"abc\":\"2!?xY\"}"
}
}