---
title: "API Key 조회"
slug: "apigateway-apikey-apikeys-search"
tags: ["API Gateway", "API Key"]
updated: 2026-07-23T09:04:29Z
published: 2026-07-23T09:04:29Z
canonical: "api.ncloud-docs.com/apigateway-apikey-apikeys-search"
---

> ## 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/api-keys/search |

### 요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 [API Gateway 요청 헤더](/docs/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 구문

요청 구문은 다음과 같습니다.

```
{
  "offset" : 0,
  "limit" : 0,
  "productId" : "productId",
  "apiKeyName" : "apiKeyName",
  "statusSet" : [ "statusSet" ]
}
```

### 요청 바디

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `offset` | Long | Optional | 조회할 데이터 목록에서 시작할 위치 - 0~9,223,372,036,854,775,807 |
| `limit` | Long | Optional | 한 번에 조회할 데이터 개수 - 1~9,223,372,036,854,775,807 |
| `productId` | Long | Required | API Key와 연결된 Product ID - 1~10 |
| `apiKeyName` | String | Optional | API Key 이름으로 필터링 - 0~20 |
| `statusSet` | Object | Optional | Product에 연결된 API Key의 상태로 필터링 - `ACCEPTED` \| `REJECTED` \| `REQUEST` \| `DENY` \| `BLOCKED_REQUEST` - `ACCEPTED`: 승인 - `REJECTED`: 거부 - `REQUEST`: 요청 - `DENY`: 요청 거부 - `BLOCKED_REQUEST`: 요청 차단 |

### 요청 예시

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

```
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/search' \
--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}'
--data '{
  "offset" : 6,
  "limit" : 1,
  "productId": "*****xn0bk",
  "apiKeyName" : "apiKey-***",
  "statusSet" : [ "REQUEST" ]
}'
```

## 응답

응답 형식을 설명합니다.

### 응답 구문

응답 구문은 다음과 같습니다.

```
{
    "apiKeys": [
        {
            "apiKeyId": "apiKeyId",
            "apiKeyName": "apiKeyName",
            "apiKeyDescription": "apiKeyDescription",
            "status": "status"
        }
    ],
    "total": 0
}
```

### 응답 상태 코드

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)를 참조해 주십시오.

### 응답 예시

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

```
{
    "apiKeys": [
        {
            "apiKeyId": "*****vg079",
            "apiKeyName": "apiKey-***",
            "apiKeyDescription": "apiKey-*** Description",
            "status": "ACCEPTED"
        }
    ],
    "total": 1
}
```