Skip to main content

Visão geral

Use este endpoint para atualizar nome, limite de uso, modelos permitidos, data de expiração ou status de uma API Key existente.

Corpo da requisição

A requisição PATCH deve incluir pelo menos um campo.

Observações

  • Os campos monetários aceitam apenas USD. Entradas em CNY foram descontinuadas e retornam 400 currency_retired.
  • A exclusão definitiva não é suportada intencionalmente na Management API v1.
  • revoked costuma ser tratado como estado terminal; se você precisar usar outra chave, normalmente é melhor criar uma nova.

Exemplo

Requisição / Resposta

Consulte o painel interativo de OpenAPI acima para ver o schema exato e os campos da resposta.

Exemplo de resposta

Campos importantes

string
Identificador da chave de API usado em chamadas subsequentes da API de Gerenciamento.
string
Nome de exibição da chave de API.
string
Prefixo de chave não secreto para exibição e suporte.
string
Um dos valores active, inactive ou revoked.
number | null
Limite de gastos em USD como número JSON para exibição. null significa ilimitado.
string | null
Limite de gastos exato em USD como string decimal. null significa ilimitado.
number
Gasto de uso acumulado em USD como número JSON para exibição.
string
Gasto de uso acumulado exato em USD como string decimal.
string[]
Lista de modelos permitidos por chave. Um array vazio significa que não há restrição adicional de modelo no nível da chave.
string | null
Carimbo de data/hora ISO em que a chave expira, ou null quando não há expiração.
string | null
Carimbo de data/hora ISO do uso mais recente, ou null quando nunca foi usada.
string
Carimbo de data/hora ISO de criação.