> ## Documentation Index
> Fetch the complete documentation index at: https://manual.seahorse.dnotitia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> API Key 생성 — Key Name·Permission 입력 후 발급. 키 값은 생성 직후 한 번만 표시

# Apikey create

# API Key 생성

**경로**: Console → **Management → API Keys** → 우측 상단 **+ Create**

<img src="https://mintcdn.com/dnotitia-328335e7/nH6QAwwQZ-jsIFdi/.gitbook/assets/admin__Managementkey2.png?fit=max&auto=format&n=nH6QAwwQZ-jsIFdi&q=85&s=4c4a610d7b941fdff928b8f8786784c7" alt="생성 다이얼로그" width="982" height="804" data-path=".gitbook/assets/admin__Managementkey2.png" />

## 입력 필드

다이얼로그 구성: `Create API Key` 제목 + Name 입력란(플레이스홀더 `Enter key name`) + Permission 드롭다운(기본값 `Read`) + **Cancel** / **Create** 버튼.

| 필드             | 설명                  | 필수 | 기본값 / 예시                                                  |
| -------------- | ------------------- | -- | --------------------------------------------------------- |
| **Key Name**   | API Key 이름 (사용자 지정) | ✓  | 플레이스홀더 `Enter key name` · 예: `dev-read-only` · `prod-etl` |
| **Permission** | 키 권한 범위 드롭다운        | ✓  | 기본 `Read` / 변경 시 `Write`                                  |

### Permission 선택

| 값         | 허용 동작                                                        | 사용 예                              |
| --------- | ------------------------------------------------------------ | --------------------------------- |
| **READ**  | 조회 전용 — Table 검색·Record 조회·Storage 파일 목록·에이전트 호출(질의)         | 외부 RAG 검색, 읽기 전용 대시보드, 사내 챗봇      |
| **WRITE** | 조회 + 생성·수정·삭제 — Table/Record Insert·Storage Upload·에이전트 업데이트 | 데이터 파이프라인, 문서 자동 업로드 배치, 관리자 스크립트 |

자세한 권한 가이드: [API Key 목록 — 권한](/console/management/api-keys/apikey-list#권한-permission)

<Info>
  **최소 권한 원칙** — 조회만 필요하면 반드시 **READ** 로 발급. WRITE 는 구성 자동화·배치 파이프라인에만.
</Info>

## 생성 흐름

<Steps>
  <Step title="+ Create 버튼">
    **Management → API Keys** 목록의 우측 상단 **+ Create** 클릭 → 입력 다이얼로그.
  </Step>

  <Step title="Key Name · Permission 입력">
    위 표 참고. 필수 필드 모두 채워지면 **Create** 활성화.
  </Step>

  <Step title="성공 다이얼로그 — 키 값 복사">
    생성 즉시 새 다이얼로그에 **API Key 값 전체** 가 monospace 폰트로 표시됩니다.

    * **복사 버튼** (Content Copy Icon) → 클립보드로 복사
    * 경고 문구: `API Key는 한 번만 표시됩니다. 지금 복사하여 안전한 곳에 보관하세요.`

    <Warning>
      **다이얼로그를 닫으면 평문 키 값을 다시 조회할 수 없습니다.** 반드시 이 시점에 복사·안전한 저장소(Vault·AWS Secrets Manager·GitHub Actions Secrets 등)에 보관하세요. 분실 시에는 기존 키 **비활성 후 신규 발급 + 이전 키 삭제** 가 유일한 복구 경로입니다.
    </Warning>
  </Step>

  <Step title="다이얼로그 닫기">
    **Close** 또는 배경 클릭. 이후 목록에 새 키가 나타나며, **평문 값은 더 이상 노출되지 않습니다** (목록에서는 마스킹·선택 연결만 가능).
  </Step>
</Steps>

## 보안 주의

<Warning>
  * **WRITE 권한 키를 프론트엔드·모바일 앱·공개 저장소에 포함하지 마세요** — 브라우저/앱 바이너리에서 추출 가능.
  * **서비스별·환경별(dev/stage/prod) 로 키를 분리** — 유출 시 해당 키만 비활성 처리하면 영향 최소화.
  * **Key Name 은 용도가 드러나게** 작명 (예: `prod-pipeline-write`, `external-dashboard-read`). 감사·회수 시 구분이 쉬워집니다.
  * 생성 즉시 **환경변수 또는 비밀 관리자** 로 이동. 소스 코드·Slack·이메일·Notion 등에 평문 저장 금지.
</Warning>

## 관련 문서

* [API Key 목록](/console/management/api-keys/apikey-list) — 전체 목록·권한 가이드·보안 주의 상세
* [API Key 상태 수정](/console/management/api-keys/update-status) — 활성/비활성 토글
* [API Key 삭제](/console/management/api-keys/apikey-delete) — 영구 제거
* [API Keys 기능 개요](/console/management/api-keys)