api-keys

POST `/v1/api-keys`

Create an API key.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění apikeys.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako pole v těle JSON.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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`.

Parametry

Název	Typ	Požadováno	Co to je
`Idempotency-Key (header)`	`string`	Ne	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Tělo požadavku

Název	Typ	Požadováno	Co to je
`name`	`string`	Ano	—
`scopes`	`string[]`	Ne	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`	Ne	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	Ne	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ano	—
`prefix`	`string`	Ano	The key's public lookup id (the middle segment of the token).
`scopes`	`string[]`	Ano	The RBAC permission keys this key may exercise.
`sandbox`	`boolean`	Ano	A sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
`last_used_at`	`object`	Ne	When the key last authenticated a request; null if never used.
`revoked_at`	`object`	Ne	Always null on a listed/fetched key — revoked keys are not returned.
`created_at`	`string`	Ano	—
`token`	`string`	Ano	The full `zdk_<mode>_<prefix>_<secret>` token. Shown once, here only — store it now; it cannot be retrieved again, only replaced.

Chyby, které může tento koncový bod vrátit

401 · 403 · 409 · 422 · 429