Update Protection Key

Prev Next

VPC 환경에서 이용 가능합니다.

Secret 보호 키를 변경합니다. REVOKE(삭제 요청) 상태인 시크릿의 보호 키는 변경할 수 없습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PUT /api/v1/secrets/{secretId}/protection-key

요청 헤더

Secret Manager API에서 공통으로 사용하는 헤더에 대한 정보는 Secret Manager 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
secretId String Required 시크릿 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
protectionKeyType String Required 보호 키 타입
  • DEFAULT (기본값) | USER_MANAGED_KEY
    • DEFAULT: 기본 키
    • USER_MANAGED_KEY: 사용자 관리 키
kmsKeyTag String Conditional KMS 키 태그

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PUT 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/protection-key' \
--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 '{
    "protectionKeyType": "USER_MANAGED_KEY",
    "kmsKeyTag": "*****a8e99ef1ba49b9c190a0cb4f6fb20cff86dd3a3017fd6ee05aea8b*****"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
code String - 응답 코드
data Object - 응답 결과
data.secretId String - 시크릿 아이디
data.protectionKey Object - 보호 키 정보
data.protectionKey.type String - 보호 키 타입
  • DEFAULT (기본값) | USER_MANAGED_KEY
    • DEFAULT: 기본 키
    • USER_MANAGED_KEY: 사용자 관리 키
data.protectionKey.kmsKeyTag String - KMS 키 태그
data.protectionKey.kmsKeyName String - KMS 키 이름

응답 상태 코드

Secret Manager API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Secret Manager 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": "SUCCESS",
    "data": {
        "secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
        "protectionKey": {
            "type": "USER_MANAGED_KEY",
            "kmsKeyTag": "*****a8e99ef1ba49b9c190a0cb4f6fb20cff86dd3a3017fd6ee05aea8b*****",
            "kmsKeyName": "test-***"
        }
    }
}