Update Secret Value

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
PUT	/api/v1/secrets/{secretId}/values

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`secretId`	String	Required	シークレット ID Get Secret Listを参照

リクエストボディ

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

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

注意

リクエストボディに入力した値のみ変更され、シークレットステージのシークレット値が空の場合は、そのステージ値を削除します。特定のステージのシークレット値のみ更新する方法は、Update Secret Stage Valueをご参照ください。

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "encryptedSecretChain": {
            "previous": "ncpkms:v1:/*****ROoPnOWY7YmmKQFwuBuAaqnU1EdnJl2VORPtW2YBj/Kr1*****",
            "active": "ncpkms:v1:*****iseiMDx/Xs8VPsLviPnVLKKO9qkMHo8l5o7L0q9E/shi1*****=",
            "pending": "ncpkms:v1:*****GGkJ234mjiKOhmyYnUR20MTGl+MB/0u5yXjG1Ti6EZ9Gq*****="
        }
    }
}