--- title: "API Key 목록 조회" slug: "apigateway-product-getapikeylist" tags: ["API Gateway", "Product", "API Key"] updated: 2026-07-23T09:04:32Z published: 2026-07-23T09:04:32Z canonical: "api.ncloud-docs.com/apigateway-product-getapikeylist" --- > ## 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. # API Key 목록 조회 Classic/VPC 환경에서 이용 가능합니다. 사용자가 지정한 조건을 만족하는 API Key 목록을 조회합니다. ## 요청 요청 형식을 설명합니다. 요청 형식은 다음과 같습니다. | 메서드 | URI | | --- | --- | | POST | /api/v1/products/{product-id}/api-keys/search | ### 요청 헤더 API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 [API Gateway 요청 헤더](/docs/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오. ### 요청 경로 파라미터 요청 경로 파라미터에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `product-id` | String | Required | API Key를 조회할 Product ID - 0~10자 - [Product 목록 조회](/docs/apigateway-product-getproductlist) 참조 | ### 요청 구문 요청 구문은 다음과 같습니다. ``` { "apiKeyValue" : "apiKeyValue", "offset" : 6, "limit" : 0, "apiKeyId" : "apiKeyId", "statusSet" : [ "REQUEST" ] } ``` ### 요청 바디 요청 바디에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `apiKeyValue` | String | Optional | Primary Key 또는 Secondary Key 값 | | `offset` | Long | Optional | 응답 데이터의 시작 지점 - 0~9,223,372,036,854,775,807 - `limit`과 함께 페이지네이션 구현에 사용 | | `limit` | Long | Optional | 응답 데이터의 최대 수 - 1~9,223,372,036,854,775,807 - `offset`과 함께 페이지네이션 구현에 사용 | | `apiKeyId` | String | Optional | API Key ID - 0~10자 - [API Key 목록 조회](/docs/apigateway-product-getapikeylist) 참조 | | `statusSet` | Array | Optional | API Key의 상태 - `REQUEST` \| `DENY` \| `ACCEPTED` \| `REJECTED` \| `BLOCKED_REQUEST` - `REQUEST`: 요청 - `DENY`: 요청 거부 - `ACCEPTED`: 승인 - `REJECTED`: 거부 - `BLOCKED_REQUEST`: 요청 차단 | ### 요청 예시 요청 예시는 다음과 같습니다. ``` curl --location --request POST'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/api-keys/search' \ --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 '{ "limit": 1, "statusSet": [ "ACCEPTED" ] }' ``` ## 응답 응답 형식을 설명합니다. ### 응답 구문 응답 구문은 다음과 같습니다. ``` { "apiKeyPage" : { "total" : 0, "content" : [ { "domainCode" : "domainCode", "regTime" : "2000-01-23T04:56:07.000+00:00", "secondaryKey" : "secondaryKey", "modTime" : "2000-01-23T04:56:07.000+00:00", "apiKeyId" : "apiKeyId", "apiKeyName" : "apiKeyName", "primaryKey" : "primaryKey", "status" : "REQUEST" } ] } } ``` ### 응답 상태 코드 API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [API Gateway 응답 상태 코드](/docs/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오. ### 응답 예시 응답 예시는 다음과 같습니다. ``` { "apiKeyPage": { "content": [ { "primaryKey": "***cPwqGb81wdWGWTS0rJc6WSoamDEmWtL2T6***", "secondaryKey": "***1rDumQKkUPD8ogxdpAouZRMTNy9YTFliHP***", "apiKeyId": "***g2ya***", "apiKeyName": "apikey001", "regTime": "2024-05-09T00:58:08Z", "modTime": "2024-05-09T00:58:08Z", "status": "ACCEPTED", "domainCode": "PUB" } ], "total": 2 } } ```