Enable Auto Rotation

Prev Next

VPC環境で利用できます。

シークレットの自動ローテーションを設定します。

リクエスト

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

メソッド URI
POST /api/v1/secrets/{secretId}/enable-auto-rotation

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
rotationPeriod Integer Optional シークレット自動ローテーション周期(日)
  • 1~730 (デフォルト: 90)
triggerId String Conditional トリガー ID
  • 関連付けられたトリガーが存在しないか変更したい場合は、必ず入力
  • Get Trigger Listを参照

リクエスト例

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

curl --location --request POST 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/enable-auto-rotation' \
--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 '{
    "rotationPeriod": 90,
    "triggerId": "*****"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
data Object - レスポンス結果
data.secretId String - シークレット ID
data.autoRotationYN String - 自動ローテーションするか
  • Y: 自動ローテーション (有効値)
data.autoRotationPeriod Integer - シークレット自動ローテーション周期(日)
data.nextRotationDate Long - 次のローテーション予定日時(ミリ秒)
  • Unix Timestamp形式
data.trigger Object - トリガー情報
data.trigger.id String - トリガー ID
data.trigger.name String - トリガー名
data.trigger.url String - トリガー URL
data.trigger.recentlyExecutedAction String - 最近実行されたアクション
  • 実際アクションを実行した履歴がある場合、表示

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
        "autoRotationYN": "Y",
        "autoRotationPeriod": 90,
        "nextRotationDate": 1761015600000,
        "trigger": {
            "id": "*****",
            "name": "test",
            "url": "https://console.ncloud.com/vpcCloudFunctions/trigger/detail/test"
        }
    }
}