Remplacer le plafond d’une clé API
Management key required. Définit un plafond illimité, fixe ou périodique sans réinitialiser l’utilisation.
api_key_id dans l’URL correspond au champ id, au format ak_..., renvoyé par Créer une clé API de modèle (POST /public/v1/api-keys). Conservez-le pour désactiver ou supprimer la clé, définir son plafond et consulter son utilisation. Le champ key (apikey-...) sert aux appels de modèles ; les appels de gestion utilisent toujours mgmt-... dans l’en-tête d’autorisation.
Management key required. Use a Management API Key (mgmt-...) for your Team, created by a Team Owner. Requests use the Team associated with that key.
Follows Console allowance semantics. Fixed allowances count from key creation; periodic allowances use UTC calendar days, Monday-based weeks, or months. Preserves credentials, enabled state, creation time and usage. Lowering the limit below existing usage is allowed; enforcement follows the existing gateway cache and in-flight settlement behavior. Disabled, expired and archived-project keys may be updated; deleted keys return 404.
Authorization
ManagementKeyBearer Management key required. Send Authorization: Bearer mgmt-....
In: header
Path Parameters
The id returned by Create a model API key (POST /public/v1/api-keys). Copy the complete ak_... value into this path parameter. Use the mgmt-... management key in the authorization header; the returned key (apikey-...) is for model calls.
^ak_[0-9A-Za-z]{22}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
unlimited requires no period and zero/omitted/null amount. fixed requires a positive amount and no period. periodic requires a positive amount and daily, weekly or monthly period. Amounts retain eight fractional digits.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/public/v1/api-keys/ak_0123456789ABCDEFGHIJKL/allowance" \ -H "Content-Type: application/json" \ -d '{ "type": "periodic", "period": "monthly", "amount": { "value": "100.00", "currency": "usd" } }'{ "object": "api_key_allowance", "api_key_id": "ak_0123456789ABCDEFGHIJKL", "type": "periodic", "period": "monthly", "amount": { "value": "100.00000000", "currency": "usd" }, "request_id": "req_example"}Last updated on