api-keys

POST `/v1/api-keys`

Create an API key.

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso apikeys.manage; una clave que no lo tenga se rechazará con un código 403, no 404.

Donde va el ID de tu organización

Este endpoint toma org_id como un campo en el cuerpo JSON.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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

Nombre	Tipo	Obligatorio	¿Qué es esto?
`Idempotency-Key (header)`	`string`	No	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`name`	`string`	Sí	—
`scopes`	`string[]`	No	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`	No	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	No	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Respuesta

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

Errores que este endpoint puede devolver

401 · 403 · 409 · 422 · 429