---
title: "API 조회"
slug: "apigateway-dashboardapikey-apis"
tags: ["API Gateway", "API Key", "Dashboard"]
updated: 2026-04-23T08:55:55Z
published: 2026-04-23T09:02:24Z
---

> ## 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 조회

<p class="platform-info type-classic-vpc">Classic/VPC 환경에서 이용 가능합니다.</p>

Dashboard의 API Key 관련 파라미터를 이용하여 Product에 생성되어 배포된 API를 조회합니다.

## 요청<a name="요청"></a>
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
| :--- | :--- |
| GET | /api/v1/dashboards/api-keys/{api-key-id}/products/{product-id}/api-ids |

### 요청 헤더<a name="요청헤더"></a>
API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 [API Gateway 요청 헤더](/docs/ai-application-service-apigateway#요청헤더)를 참조해 주십시오.

### 요청 경로 파라미터 <a name="요청경로파라미터"></a>
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
| :--- | :--- | :--- | :--- |
| `api-key-id` | String | Required | Product에 연결된 API Key ID |
| `product-id` | String | Required | API에 연결된 Product ID |

### 요청 쿼리 파라미터<a name="요청쿼리파라미터"></a>
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
| :--- | :--- | :--- | :--- |
| `regions` | List[String] | Optional | API를 조회할 리전<ul><li>컬렉션의 아이템은 null일 수 없음</li></ul> |
| `offset` | Long | Optional | 조회할 데이터 목록에서 시작할 위치<ul><li> 0~9,223,372,036,854,775,807</li></ul> |
| `limit` | Long | Optional | 한 번에 조회할 데이터 개수<ul><li> 1~9,223,372,036,854,775,807</li></ul> |
| `from` | String | Required | 조회 시작 일자<ul><li>yyyy-MM-dd 형식</li></ul> |
| `to` | String | Required | 조회 종료 일자<ul><li>yyyy-MM-dd 형식</li></ul> |
| `timeZone` | String | Required | 타임 존(+09:00)</li><li>GET 방식 이용 시 URL 인코딩 필요</li></ul> |

### 요청 예시<a name="요청예시"></a>
요청 예시는 다음과 같습니다.
```shell
curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/api-keys?from=2024-05-09&to=2024-05-09&timeZone=%2B09%3A00' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```    
    
## 응답<a name="응답"></a>
응답 형식을 설명합니다.

### 응답 구문<a name="응답구문"></a>
응답 구문은 다음과 같습니다.
```json
{
    "apis": {
        "content": [
            {
                "apiId": "apiId",
                "apiName": "apiName",
                "deleted": true
            }
        ],
        "total": 0
    }
}
```

### 응답 상태 코드 <a name="응답상태코드"></a>
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [API Gateway 응답 상태 코드](/docs/ai-application-service-apigateway#응답상태코드)를 참조해 주십시오.

### 응답 예시<a name="응답예시"></a>
응답 예시는 다음과 같습니다. 

```json
{
    "apis": {
        "content": [
            {
                "apiId": "*****vcqwb",
                "apiName": "api-***",
                "deleted": true
            }
        ],
        "total": 1
    }
}
```