Pular para o conteúdo principal
PATCH
Atualizar uma chave de API
Este endpoint requer uma chave de API de gerenciamento. Chaves de API padrão do gateway não são aceitas.
Use esta rota para renomear uma chave, ajustar escopos, definir expiração, desativá-la ou definir um limite de gastos com limit e limit_reset.

Autorizações

Authorization
string
header
obrigatório

Autenticação com token Bearer

Parâmetros de caminho

id
string
obrigatório

Identificador ou hash da chave de API.

Corpo

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

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

limit
number | null

Limite de gastos opcional em USD para esta chave. Defina como null para removê-lo.

Intervalo obrigatório: x >= 0
limit_reset
enum<string>

Período usado para a janela do limite de gastos.

Opções disponíveis:
daily,
weekly,
monthly
include_byok_in_limit
boolean

Aceito por compatibilidade. O comportamento atual do Phaseo sempre exclui o BYOK deste limite.

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

Departamento ao qual esta chave pertence para os limites de taxa e os orçamentos do departamento. Null significa que a chave conta apenas para os limites de todo o espaço de trabalho.

storage_locations
string[] | null

Onde você guarda esta chave, como a plataforma de hospedagem cujas variáveis de ambiente a contêm. Opcional. Se um desses lugares relatar um vazamento, você pode encontrar e revogar todas as chaves armazenadas lá. IDs conhecidos: 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}$
Exemplo:
ip_allowlist
object[]

Endereços autorizados a usar a chave. Cada entrada é um endereço IPv4 ou IPv6, ou um intervalo CIDR, com um rótulo. Se estiver vazia, qualquer endereço é permitido.

Maximum array length: 100

Resposta

Metadados da chave de API atualizados

data
object
obrigatório
Última modificação em 16 de novembro de 2026