Update Secret Value

Prev Next

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

전체 시크릿 스테이지의 시크릿 값을 수정합니다. REVOKE(삭제 요청) 상태인 시크릿의 값은 변경할 수 없습니다.

요청

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

메서드 URI
PUT /api/v1/secrets/{secretId}/values

요청 헤더

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

요청 경로 파라미터

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

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

요청 바디

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

필드 타입 필수 여부 설명
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*****="
        }
    }
}