Get Secret List

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

시크릿 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/secrets

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)

요청 예시

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

curl --location --request GET 'https://secretmanager.apigw.ntruss.com/api/v1/secrets?pageNo=0' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`code`	String	-	응답 코드
`data`	Object	-	응답 결과
`data.totalPageNo`	Integer	-	전체 페이지 수
`data.currentPageNo`	Integer	-	현재 페이지 번호
`data.totalCount`	Integer	-	전체 시크릿 개수
`data.secretList`	Array	-	시크릿 목록

secretList

secretList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`secretId`	String	-	시크릿 아이디
`secretName`	String	-	시크릿 이름
`secretStatus`	String	-	시크릿 상태 `ENABLE` \| `DISABLE` \| `REVOKE` \| `ROTATING` \| `DESTROYED` `ENABLE`: 이용 가능 `DISABLE`: 일시 중지 `REVOKE`: 삭제 예정 `ROTATING`: 교체 진행 중 `DESTROYED`: 최종 삭제
`secretType`	String	-	시크릿 타입 `BASIC` (유효값)
`region`	String	-	지역 코드
`registerDate`	Long	-	시크릿 생성 일시 Unix Timestamp 형식

응답 상태 코드

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

응답 예시

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

{
    "code": "SUCCESS",
    "data": {
        "totalPageNo": 1,
        "currentPageNo": 1,
        "totalCount": 2,
        "secretList": [
            {
                "secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
                "secretName": "test-***",
                "secretStatus": "ENABLE",
                "secretType": "BASIC",
                "region": "KR",
                "registerDate": 1753065580243
            }
        ]
    }
}