Saltar al contenido principal
PATCH
Actualizar una clave de API
Este endpoint requiere una clave de API de gestión. No se aceptan las claves de API estándar de la pasarela.
Usa esta ruta para cambiar el nombre de una clave, ajustar sus ámbitos, definir su caducidad, deshabilitarla o establecer un límite de gasto con limit y limit_reset.

Autorizaciones

Authorization
string
header
requerido

Autenticación con token Bearer

Parámetros de ruta

id
string
requerido

Identificador o hash de la clave de API.

Cuerpo

application/json
name
string
Minimum string length: 1
scopes
Ejemplo:

"[\"chat.completions\",\"responses\"]"

limit
number | null

Límite de gasto opcional en USD para esta clave. Establécelo en null para borrarlo.

Rango requerido: x >= 0
limit_reset
enum<string>

Período usado para la ventana del límite de gasto.

Opciones disponibles:
daily,
weekly,
monthly
include_byok_in_limit
boolean

Se acepta por compatibilidad. El comportamiento actual de Phaseo siempre excluye BYOK de este límite.

expires_at
string<date-time> | null
disabled
boolean
soft_blocked
boolean
limits
object
department_id
string<uuid> | null

Departamento al que pertenece esta clave para los límites de frecuencia y los presupuestos del departamento. Null significa que la clave solo cuenta para los límites de todo el espacio de trabajo.

storage_locations
string[] | null

Dónde guardas esta clave, por ejemplo la plataforma de alojamiento cuyas variables de entorno la contienen. Opcional. Si uno de estos lugares informa de una brecha, puedes encontrar y revocar todas las claves guardadas allí. Identificadores conocidos: railway, vercel, netlify, render, fly, heroku, cloudflare, supabase, firebase, digitalocean, replit, modal, convex, koyeb, coolify, northflank, expo, deno-deploy, aws, google-cloud, azure, hetzner, vultr, linode, ovhcloud, scaleway, kubernetes, github, gitlab, circleci, bitbucket, 1password, bitwarden, hashicorp-vault, doppler, infisical, local-machine, own-server, other.

Maximum array length: 8
Pattern: ^[a-z0-9][a-z0-9-]{0,39}$
Ejemplo:
ip_allowlist
object[]

Direcciones que pueden usar la clave. Cada entrada es una dirección IPv4 o IPv6, o un rango CIDR, con una etiqueta. Si está vacía, se permite cualquier dirección.

Maximum array length: 100

Respuesta

Metadatos de la clave de API actualizados

data
object
requerido
Última modificación el 16 de noviembre de 2026