MENU
      Update Protection Key

        Update Protection Key


        Article summary

        Overview

        Change the protection key of a secret.
        The protection key of a secret in the REVOKE (deletion requested) status can't be changed.

        PUT https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/protection-key
        HTTP

        Request

        Request parameter

        Parameter nameTypeDescription
        secretIdStringSecret ID

        Request body

        {
          "protectionKeyType": "DEFAULT",
          "kmsKeyTag": "string"
        }
        JSON
        Parameter nameTypeDescription
        protectionKeyTypeStringSecret protection key type (DEFAULT, USER_MANAGED_KEY)
        kmsKeyTagStringKMS key tag

        Response

        Response body

        {
          "code": "SUCCESS",
          "data": {
            "secretId": "string",
            "protectionKey": {
              "type": "DEFAULT",
              "kmsKeyTag": "string",
              "kmsKeyName": "string"
            }
          }
        }
        JSON
        Parameter nameTypeDescription
        secretIdStringSecret ID
        protectionKey.typeStringProtection key type (DEFAULT, USER_MANAGED_KEY)
        protectionKey.kmsKeyTagStringKMS key tag
        protectionKey.kmsKeyNameStringKMS key name

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.