Skip to main content

Vue d’ensemble

Utilisez cet endpoint pour mettre à jour le nom, la limite d’usage, les modèles autorisés, l’expiration ou le statut d’une API Key utilisateur existante.

Corps de la requête

Au moins un champ doit être fourni dans la requête PATCH.

Notes

  • Les champs monétaires prennent uniquement en charge l’USD. Les entrées CNY sont abandonnées et renvoient 400 currency_retired.
  • Les champs monétaires sont réservés au USD. Les entrées CNY sont obsolètes et renvoient 400 currency_retired.
  • Le hard delete n’est volontairement pas pris en charge dans Management API v1.
  • revoked est terminal pour l’usage opérationnel courant ; créez une nouvelle clé au lieu d’attendre un futur flux de réactivation.

Exemple

Requête / Réponse

Utilisez le panneau OpenAPI interactif ci-dessus pour obtenir le schéma exact et les champs de réponse.

Exemple de réponse

Champs importants

string
Identifiant de clé API utilisé dans les appels ultérieurs à l’API de gestion.
string
Nom d’affichage de la clé API.
string
Préfixe de clé non secret pour l’affichage et l’assistance.
string
L’une des valeurs active, inactive ou revoked.
number | null
Plafond de dépenses en USD renvoyé sous forme de nombre JSON pour l’affichage. null signifie aucune limite.
string | null
Plafond de dépenses exact en USD renvoyé sous forme de chaîne décimale. null signifie aucune limite.
number
Dépenses d’utilisation cumulées en USD renvoyées sous forme de nombre JSON pour l’affichage.
string
Dépenses d’utilisation cumulées exactes en USD renvoyées sous forme de chaîne décimale.
string[]
Liste des modèles autorisés par clé. Un tableau vide signifie qu’aucune restriction de modèle supplémentaire ne s’applique au niveau de la clé.
string | null
Horodatage ISO d’expiration de la clé, ou null si elle n’expire pas.
string | null
Horodatage ISO de la dernière utilisation, ou null si elle n’a jamais été utilisée.
string
Horodatage ISO de création.