Enable Auto Rotation

Prev Next

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

시크릿의 자동 교체를 설정합니다.

요청

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

메서드 URI
POST /api/v1/secrets/{secretId}/enable-auto-rotation

요청 헤더

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

요청 경로 파라미터

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

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

요청 바디

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

필드 타입 필수 여부 설명
rotationPeriod Integer Optional 시크릿 자동 교체 주기(일)
  • 1~730 (기본값: 90)
triggerId String Conditional 트리거 아이디
  • 연결된 트리거가 없거나 변경하려는 경우, 필수 입력
  • 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 - 시크릿 아이디
data.autoRotationYN String - 자동 교체 여부
  • Y: 자동 교체 (유효 값)
data.autoRotationPeriod Integer - 시크릿 자동 교체 주기(일)
data.nextRotationDate Long - 다음 교체 예정 일시(밀리초)
  • Unix Timestamp 형식
data.trigger Object - 트리거 정보
data.trigger.id String - 트리거 아이디
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"
        }
    }
}