api-keys

POST `/v1/api-keys`

Create an API key.

모든 api-keys 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 apikeys.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

조직 ID가 들어가는 위치

이 엔드포인트는 JSON 본문의 필드로 org_id을(를) 받습니다.

조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

curl -X POST https://api.zinndigital.com/v1/api-keys \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

Mints a new per-org API key and returns the full `zdk_…` token **once** — only its hash is stored, so a lost token is replaced, never recovered. The requested `scopes` must be permissions the caller already holds in the target org; asking for one you do not hold is a `403` (a key can never out-scope its creator). Send an `Idempotency-Key` so a retry after a lost response returns the same token rather than orphaning a key. Requires `apikeys.manage`.

매개변수

이름	유형	필수	설명
`Idempotency-Key (header)`	`string`	아니요	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

요청 본문

이름	유형	필수	설명
`name`	`string`	예	—
`scopes`	`string[]`	아니요	RBAC permission keys to grant. Each must be a permission the caller holds in the target org (a key can never out-scope its creator); an unheld scope is a `403`, an unknown one a…
`sandbox`	`boolean`	아니요	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	아니요	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

응답

이름	유형	필수	설명
`id`	`Uuid`	예	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	예	—
`prefix`	`string`	예	The key's public lookup id (the middle segment of the token).
`scopes`	`string[]`	예	The RBAC permission keys this key may exercise.
`sandbox`	`boolean`	예	A sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
`last_used_at`	`object`	아니요	When the key last authenticated a request; null if never used.
`revoked_at`	`object`	아니요	Always null on a listed/fetched key — revoked keys are not returned.
`created_at`	`string`	예	—
`token`	`string`	예	The full `zdk_<mode>_<prefix>_<secret>` token. Shown once, here only — store it now; it cannot be retrieved again, only replaced.

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 409 · 422 · 429