Update Secret Stage Value

Prev Next

VPC環境で利用できます。

シークレットステージのシークレット値を更新します。REVOKE(削除リクエスト)状態のシークレット値は変更できません。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PUT /api/v1/secrets/{secretId}/values/{secret-value-stage}

リクエストヘッダ

Secret Manager APIで共通して使用されるヘッダの詳細は、Secret Managerのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
secretId String Required シークレット ID
secret-value-stage String Required シークレットステージ
  • previous | active | pending
    • previous: PREVIOUSステージ(ACTIVEステージの以前使用したシークレット)
    • active: ACTIVEステージ(現在正常に使用されている有効なシークレット)
    • pending: PENDINGステージ(ローテーションが新たに開始され、ローテーション完了待ちのシークレット)

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
value String Required シークレット値

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request PUT 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/values/previous' \
--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 '{
    "value": "{\"abc\":\"cba\"}"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
data Object - レスポンス結果
data.encryptedSecretValue Object - 暗号化されたシークレット値情報
data.encryptedSecretValue.value String - 暗号化されたシークレット値
data.encryptedSecretValue.valueStage String - シークレットステージ
  • previous | active | pending
    • previous: PREVIOUSステージ(ACTIVEステージの以前使用したシークレット)
    • active: ACTIVEステージ(現在正常に使用されている有効なシークレット)
    • pending: PENDINGステージ(ローテーションが新たに開始され、ローテーション完了待ちのシークレット)

レスポンスステータスコード

Secret Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Secret Managerのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "SUCCESS",
    "data": {
        "encryptedSecretValue": {
            "value": "ncpkms:v1:*****0ObO7xznMJWUptMNLK/IZsEbp+****+6wRDfCcQW93r5FfG****",
            "valueStage": "PREVIOUS"
        }
    }
}