Mettre à jour une API Key

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.

Champ	Type	Valeurs par défaut / limites	Description
`status`	enum	-	`active`, `inactive`, `revoked`
`name`	string	longueur `1-50`	Nom affiché mis à jour
`limitAmount`	number \| string \| null	`0–100000` USD	`null` signifie sans limite ; `0` empêche toute dépense. Les chaînes décimales acceptent jusqu’à 6 décimales.
`limitCurrency`	enum	valeur par défaut `USD`	USD uniquement. L'envoi de `CNY` renvoie `400 currency_retired`. Si ce champ est fourni, `limitAmount` est obligatoire.
`models`	string[]	-	Liste d’autorisation des modèles logiques mise à jour
`deliveryPolicy`	string \| null	`auto`, `verified`, `official`, `null`	`null` hérite de la politique de livraison de l’espace de travail.
`expiresAt`	string \| null	datetime RFC3339	`null` efface la date d’expiration

Notes

Les champs monétaires prennent uniquement en charge l’USD. Les entrées CNY sont abandonnées 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

cURL

curl -X PATCH "https://api.tokenlab.sh/v1/management/api-keys/key_abc123def456" \
  -H "Authorization: Bearer mt-your-management-token" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive",
    "limitAmount": 0
  }'

Cette page fournit le schéma OpenAPI et des exemples de requêtes à copier. Envoyez les requêtes de gestion depuis votre terminal ou votre client avec un Management Token ; l’envoi direct n’est pas disponible sur cette page.

Exemple de réponse

Réponse

200 OK

{
  "id": "key_abc123def456",
  "name": "Backend Worker",
  "key_prefix": "sk-live...",
  "status": "inactive",
  "limit_amount": 0,
  "limit_amount_decimal": "0",
  "used_amount": 148.25,
  "used_amount_decimal": "148.25",
  "models": [
    "gpt-5.6-luna",
    "claude-3-7-sonnet"
  ],
  "expires_at": "2026-12-31T23:59:59.000Z",
  "last_used_at": "2026-07-08T03:12:45.000Z",
  "created_at": "2026-07-01T10:00:00.000Z",
  "delivery_policy": null
}

Champs importants

idstring

Identifiant de clé API utilisé dans les appels ultérieurs à l’API de gestion.

namestring

Nom d’affichage de la clé API.

key_prefixstring

Préfixe de clé non secret pour l’affichage et l’assistance.

statusstring

L’une des valeurs active, inactive, suspended ou revoked.

limit_amountnumber | null

Plafond de dépenses en USD renvoyé sous forme de nombre JSON pour l’affichage. null signifie aucune limite.

limit_amount_decimalstring | null

Plafond de dépenses exact en USD renvoyé sous forme de chaîne décimale. null signifie aucune limite.

used_amountnumber

Dépenses d’utilisation cumulées en USD renvoyées sous forme de nombre JSON pour l’affichage.

used_amount_decimalstring

Dépenses d’utilisation cumulées exactes en USD renvoyées sous forme de chaîne décimale.

modelsstring[]

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é.

delivery_policystring | null

auto, verified, official, null. null hérite de la politique de livraison de l’espace de travail.

expires_atstring | null

Horodatage ISO d’expiration de la clé, ou null si elle n’expire pas.

last_used_atstring | null

Horodatage ISO de la dernière utilisation, ou null si elle n’a jamais été utilisée.

created_atstring

Horodatage ISO de création.

Autorisation

ManagementTokenAuth

AuthorizationBearer <token>

Authentification par jeton de gestion. Créez ou gérez vos jetons de gestion dans Dashboard > API > Management Tokens.

Emplacement: header

Paramètres de chemin

keyId*string

Corps de la requête

application/json

Au moins un champ doit être fourni.

Propriétés1 <= properties

status?string

Statut du cycle de vie de la clé API utilisateur.

Valeurs possibles

"active"
"inactive"
"suspended"
"revoked"

name?string

Nom d'affichage mis à jour. La longueur doit être comprise entre 1 et 50 caractères après troncature.

Longueur1 <= length <= 50

limitAmount?|

Limite de dépenses mise à jour en USD. null signifie illimité et 0 signifie un quota nul.

Plage0 <= value <= 1000000

limitCurrency?"USD"

Devise pour limitAmount. USD est la seule devise active. L'envoi de CNY renvoie 400 currency_retired.

par défaut"USD"

Valeurs possibles

"USD"

models?array<string>

Liste blanche de modèles mise à jour.

expiresAt?|

Horodatage d'expiration RFC3339 mis à jour. null supprime l'expiration.

Formatdate-time

deliveryPolicy?|

Politique de livraison par clé. null hérite de la valeur par défaut de l'espace de travail.

Valeurs possibles

"auto"
"verified"
"official"
null

Mettre à jour une API Key

Vue d’ensemble

Corps de la requête

Notes

Exemple

Requête / Réponse

Exemple de réponse

Champs importants

Autorisation

Paramètres de chemin

Corps de la requête

Réponse

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Mettre à jour une API Key

Vue d’ensembleCopy Anchor Link

Corps de la requêteCopy Anchor Link

NotesCopy Anchor Link

ExempleCopy Anchor Link

Requête / RéponseCopy Anchor Link

Exemple de réponseCopy Anchor Link

Champs importantsCopy Anchor Link

AutorisationCopy Anchor Link

Paramètres de cheminCopy Anchor Link

Corps de la requêteCopy Anchor Link

RéponseCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

Vue d’ensemble

Corps de la requête

Notes

Exemple

Requête / Réponse

Exemple de réponse

Champs importants

Autorisation

Paramètres de chemin

Corps de la requête

Réponse

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`