Skip to main content
POST
Crear una API Key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string<uuid>

Identificador del workspace multi-tenant. Obligatorio al autenticar con Authorization: Bearer, donde su ausencia devuelve 400 Workspace context is required. Con x-api-key es opcional: la llave ya identifica a su workspace y lo que mandes aquí se ignora.

Body

application/json
name
string
required
Required string length: 1 - 120
description
string | null
Maximum string length: 255
environment
enum<string>

Entorno al que queda atada la llave. Es una puerta de autenticación: el despliegue que recibe la petición compara este valor contra el suyo y responde 401 API key environment mismatch si no coinciden. Si se omite, hereda el del despliegue que atiende la creación.

Available options:
production,
sandbox,
staging,
development
scopes
string[]
Minimum array length: 1
Maximum string length: 64

Response

API Key creada con éxito

id
string<uuid>
required
name
string
required
scopes
string[]
required

Lista de scopes autorizados para esta credencial.

Minimum array length: 1
environment
enum<string>
required
Available options:
production,
sandbox,
staging,
development
keyPreview
string
required

Prefijo y sufijo visibles de la API Key (el valor completo no se expone después de la creación).

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
key
string
required

Valor completo de la API Key. Solo se entrega una vez y debe almacenarse de forma segura.

description
string | null
Maximum string length: 255
lastUsedAt
string<date-time> | null

Fecha/hora del último uso registrado.

revokedAt
string<date-time> | null

Fecha/hora en que se revocó la credencial (si aplica).