Request Secret Deletion

Prev Next

VPC環境で利用できます。

シークレットの削除をリクエストします。ENABLE(利用可能)、DISABLE(一時停止)、REVOKE(削除予約)状態のシークレットのみ削除をリクエストできます。

リクエスト

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

メソッド URI
POST /api/v1/secrets/{secretId}/request-deletion

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request POST 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/request-deletion' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
data Object - レスポンス結果
data.secretId String - シークレット ID
data.secretStatus String - シークレットの状態
  • REVOKE: 削除リクエスト (有効値)
data.updateDate Long - シークレット削除リクエスト日時(ミリ秒)
  • Unix Timestamp形式

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "secretId": "*****87685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
        "secretStatus": "REVOKE",
        "updateDate": 1753167096831
    }
}