Passer au contenu principal
PATCH
Mettre à jour une clé API
Ce point de terminaison nécessite une clé API de gestion. Les clés API Gateway standard ne sont pas acceptées.
Utilisez cette route pour renommer une clé, ajuster ses périmètres, définir son expiration, la désactiver ou fixer un plafond de dépenses avec limit et limit_reset.

Autorisations

Authorization
string
header
requis

Authentification par jeton Bearer

Paramètres de chemin

id
string
requis

Identifiant ou hachage de la clé API.

Corps

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

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

limit
number | null

Plafond de dépenses facultatif en USD pour cette clé. Définissez-le sur null pour le supprimer.

Plage requise: x >= 0
limit_reset
enum<string>

Période utilisée pour la fenêtre du plafond de dépenses.

Options disponibles:
daily,
weekly,
monthly
include_byok_in_limit
boolean

Accepté pour des raisons de compatibilité. Le comportement actuel de Phaseo exclut toujours BYOK de cette limite.

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

Service auquel cette clé appartient pour les limites de débit et les budgets du service. Null signifie que la clé ne compte que pour les limites de l’ensemble de l’espace de travail.

storage_locations
string[] | null

Où vous stockez cette clé, par exemple la plateforme d’hébergement dont les variables d’environnement la contiennent. Facultatif. Si l’un de ces services signale une fuite, vous pouvez retrouver et révoquer toutes les clés qui y sont stockées. Identifiants connus : 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}$
Exemple:
ip_allowlist
object[]

Adresses autorisées à utiliser la clé. Chaque entrée est une adresse IPv4 ou IPv6, ou une plage CIDR, avec un libellé. Si la liste est vide, toutes les adresses sont autorisées.

Maximum array length: 100

Réponse

Métadonnées de la clé API mises à jour

data
object
requis
Dernière modification le 16 novembre 2026