api-keys

POST `/v1/api-keys`

Create an API key.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão apikeys.manage; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como um campo no corpo JSON.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`Idempotency-Key (header)`	`string`	Não	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`name`	`string`	Sim	—
`scopes`	`string[]`	Não	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`	Não	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	Não	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Resposta

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

Erros que este endpoint pode retornar

401 · 403 · 409 · 422 · 429