--- title: "Secret Manager 개요" slug: "secretmanager-api-overview" updated: 2026-09-17T09:16:59Z published: 2026-09-17T09:16:59Z canonical: "api.ncloud-docs.com/secretmanager-api-overview" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # Secret Manager 개요 VPC 환경에서 이용 가능합니다. Secret Manager는 보안 암호를 안전하게 관리할 수 있는 네이버 클라우드 플랫폼의 서비스입니다. Secret Manager 서비스에서는 보안 암호의 생성, 조회, 교체 및 삭제 관리와 관련된 API를 RESTful 형태로 제공합니다. ## Secret Manager 공통 설정 Secret Manager API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다. ### 요청 공통 요청 형식을 설명합니다. #### API URL 한국(KR) 리전은 Secret이 암호화된 Key Management Service(이하 KMS) 키의 격리 타입에 따라 API URL이 달라집니다. | 리전 | KMS 전역 키 암호화 연동 Secret | KMS 격리 키 암호화 연동 Secret | | --- | --- | --- | | 한국 (KR) | https://secretmanager.apigw.ntruss.com | https://ocapi-kr.ncloud.com/secretmanager | 일본 리전은 KMS의 리전 격리 키만을 이용해 암호화할 수 있으며, API URL은 아래와 같습니다. | 리전 | Secret Manager API | | --- | --- | | 일본 (JPN) | https://ocapi-jp.ncloud.com/secretmanager | 주의 Key Management Service(KMS)의 리전 격리 키 기능이 업데이트되어 Secret Manager에서도 리전 격리 키를 연동할 수 있습니다. 업데이트 이전에 전역 키로 연동된 시크릿은 그대로 사용할 수 있으나, 신규 시크릿 연동 시 전역 키는 더 이상 선택할 수 없습니다. 관련하여 자세한 내용은 [Key Management Service 개요](https://api.ncloud-docs.com/release-20260917/docs/security-kms)를 참조해 주십시오. ### 요청 헤더 요청 헤더에 대한 설명은 다음과 같습니다. | 필드 | 필수 여부 | 설명 | | --- | --- | --- | | `x-ncp-apigw-timestamp` | Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초) - API Gateway 서버와 5분 이상 시간 차 발생 시 유효하지 않은 요청으로 간주 - Unix Timestamp 형식 | | `x-ncp-iam-access-key` | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key - Access Key 발급 및 확인: [인증키 생성](/docs/common-ncpapi) 참조 - 서브 계정의 Access Key 발급 및 확인: [서브 계정 생성](https://guide.ncloud-docs.com/docs/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1) 참조 | | `x-ncp-apigw-signature-v2` | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 매핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 - Secret Key 발급 및 확인: [인증키 생성](/docs/common-ncpapi) 참조 - 서명 생성: [시그니처 생성](/docs/common-ncpapi) 참조 | | `Content-Type` | Optional | 요청 데이터의 형식 - `application/json` | ### 응답 공통 응답 형식을 설명합니다. #### 응답 바디 응답 바디에 대한 설명은 다음과 같습니다. **responseError** responseError는 API 호출 실패 정보를 정의합니다. responseError에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `error` | Object | - | 오류 정보 | | `error.errorCode` | String | - | 오류 코드 | | `error.message` | String | - | 오류 메시지 | | `error.details` | String | - | 오류에 대한 상세 정보 | #### 응답 상태 코드 응답 상태 코드에 대한 설명은 다음과 같습니다. | HTTP 상태 코드 | 코드 | 메시지 | 설명 | | --- | --- | --- | --- | | 403 | FORBIDDEN | Forbidden | 인증 완료이나 권한 없음으로 요청 거부 | | 500 | INTERNAL_SERVER_ERROR | Server internal error | 서버 내부 오류 | | 422 | UNPROCESSABLE_ENTITY | Invalid status | 요청은 유효하나 규칙 위반 | | 400 | INVALID_REQUEST | Invalid request | 잘못된 요청 | | 401 | UNAUTHORIZED | Unauthorized | 인증 정보 누락 | | 404 | NOT_FOUND | Not found | 요청 리소스 없음 | | 409 | INVALID_STATUS | Invalid status | 유효하지 않은 상태 값 | 참고 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오. #### 응답 예시 호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다. ``` { "error": { "errorCode": "string", "message": "string", "details": "string" } } ``` ## Secret Manager API Secret Manager 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [Create Secret](/docs/secretmanager-createsecret) | 시크릿 생성 | | [Get Protection Key List](/docs/secretmanager-getprotectionkeylist) | 보호 키 목록 조회 | | [Get Secret Detail](/docs/secretmanager-getsecretdetail) | 시크릿 상세 정보 조회 | | [Get Secret List](/docs/secretmanager-getsecretlist) | 시크릿 목록 조회 | | [Get Secret Logs](/docs/secretmanager-getsecretlogs) | 시크릿 이용 로그 조회 | | [Get Secret Stage Value](/docs/secretmanager-getsecretstagevalue) | 특정 시크릿 스테이지의 시크릿 값 조회 | | [Get Secret Value](/docs/secretmanager-getsecretvalue) | 시크릿 값 조회 | | [Get Trigger List](/docs/secretmanager-gettriggerlist) | 트리거 목록 조회 | | [Cancel Rotation Job](/docs/secretmanager-cancel-rotation-job) | 실행 중인 시크릿 교체 작업 취소 | | [Cancel Secret Deletion](/docs/secretmanager-cancelsecretdeletion) | 시크릿 삭제 요청 취소 | | [Disable Auto Rotation](/docs/secretmanager-disable-auto-rotation) | 시크릿 자동 교체 비활성화 | | [Disable Secret](/docs/secretmanager-disablesecret) | 시크릿 비활성화 | | [Enable Auto Rotation](/docs/secretmanager-enable-auto-rotation) | 시크릿 자동 교체 활성화 | | [Enable Secret](/docs/secretmanager-enablesecret) | 시크릿 활성화 | | [Execute Rotation Job](/docs/secretmanager-execute-rotation-job) | 시크릿 교체 작업 실행 | | [Request Secret Deletion](/docs/secretmanager-requestsecretdeletion) | 시크릿 삭제 요청 생성 | | [Retry Rotation Job](/docs/secretmanager-retry-rotation-job) | 시크릿 교체 작업 재시도 | | [Rollback Rotation Job](/docs/secretmanager-rollback-rotation-job) | 시크릿 교체 작업 롤백 | | [Update Protection Key](/docs/secretmanager-updateprotectionkey) | 보호 키 변경 | | [Update Rotation Period](/docs/secretmanager-update-rotation-period) | 시크릿 교체 주기 변경 | | [Update Rotation Trigger](/docs/secretmanager-update-rotation-trigger) | 시크릿 교체 트리거 변경 | | [Update Secret Memo](/docs/secretmanager-updatesecretmemo) | 시크릿 설명 수정 | | [Update Secret Stage Value](/docs/secretmanager-update-secret-stage-value) | 특정 시크릿 스테이지의 시크릿 값 수정 | | [Update Secret Value](/docs/secretmanager-updatesecretvalue) | 전체 시크릿 스테이지의 시크릿 값 변경 | | [Delete Rotation Trigger](/docs/secretmanager-delete-rotation-trigger) | 시크릿 교체 트리거 삭제 | | [Delete Secret](/docs/secretmanager-deletesecret) | 시크릿 삭제 | ### Secret Rotate Process Control Secret Rotate Process Control 관련 API에 대한 설명은 다음과 같습니다. | API | 설명 | | --- | --- | | [Add Pending Stage](/docs/secretmanager-add-pending-stage) | Pending 스테이지 생성 | | [Generate Random Secret](/docs/secretmanager-generate-random-secret) | 임의의 시크릿 문자열 생성 | | [Complete Rotation Job](/docs/secretmanager-complete-rotation-job) | 시크릿 교체 작업 완료 통보 | | [Fail Rotation Job](/docs/secretmanager-fail-rotation-job) | 시크릿 교체 작업 실패 통보 | | [Start Rotation Job](/docs/secretmanager-start-rotation-job) | 시크릿 교체 작업 시작 | | [Update Pending Stage](/docs/secretmanager-update-pending-stage) | Pending 스테이지의 시크릿 값 수정 | ## Secret Manager 연관 리소스 Secret Manager API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다. - Secret Manager API 사용 방법 - [서명(시그니처) 생성](/docs/common-ncpapi): 요청 헤더에 추가할 서명 생성 방법 - [Sub Account 사용 가이드](https://guide.ncloud-docs.com/docs/subaccount-overview): 요청 헤더에 추가할 Access Key 발급 방법 - [Ncloud 공통 응답 상태 코드](/docs/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): Secret Manager 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보 - Secret Manager 서비스 사용 방법 - [Secret Manager 사용 가이드](https://guide.ncloud-docs.com/docs/secretmanager-overview): 네이버 클라우드 플랫폼 콘솔에서 Secret Manager를 사용하는 방법 - [Ncloud 사용 환경 가이드](https://guide.ncloud-docs.com/docs/environment-environment-1-1): VPC, Classic 플랫폼 및 지원 여부에 대한 가이드 - [요금 소개, 특징, 상세 기능](https://www.ncloud.com/product/security/secretManager): Secret Manager의 요금 체계, 특징, 상세 기능 요약 - [서비스 최신 소식](https://www.ncloud.com/intro/news?categoryCode=SEC&serviceCode=SV_0257): Secret Manager 관련 최신 소식 - [자주 하는 질문](https://www.ncloud.com/support/faq/prod?categoryCode2=SEC&categoryCode3=SV_0257&page=1): Secret Manager 사용자들이 자주 하는 질문 - [고객 지원](https://www.ncloud.com/support/question/service): API 가이드를 통해서도 궁금증이 해결되지 않는 경우, 직접 문의