> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Mettre à jour une clé API
> Utilisez CometAPI PUT /api/token/ pour mettre à jour une clé API par ID avec les champs modifiables dans le corps JSON.
Utilisez ce endpoint pour mettre à jour le nom, le statut, le quota, l'expiration, les restrictions de modèle, la liste d'autorisation IP et les paramètres de groupe d'une clé API.
Générez un personal access token dans [Console → Paramètres personnels](https://www.cometapi.com/console/personal), puis envoyez-le comme valeur brute de l'en-tête `Authorization`. Ne le préfixez pas avec `Bearer`.
Ce endpoint utilise `PUT /api/token/`, et l'`id` doit être placé dans le corps JSON. Envoyez les champs modifiables que vous souhaitez conserver ; les champs numériques, booléens ou de chaîne omis peuvent être réinitialisés lors de la mise à jour.
## Corps de la requête
| Field | Type | Description |
| ---------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Obligatoire. ID de la clé API renvoyé par [List API keys](./list-api-keys). |
| `name` | string | Nom d'affichage lisible par l'utilisateur pour la clé. Doit contenir 50 caractères ou moins. |
| `status` | integer | Statut opérationnel. `1` active la clé pour les requêtes de modèle. `2` la désactive. `3` la marque comme expirée. `4` la marque comme quota épuisé. Les clés désactivées, expirées ou épuisées sont rejetées par les endpoints de modèle. |
| `expired_time` | integer | Horodatage Unix en secondes auquel la clé expire. Utilisez `-1` pour aucune expiration. Un horodatage passé bloque les requêtes de modèle. |
| `remain_quota` | integer | Quota restant en unités de quota internes CometAPI. Si cette valeur atteint `0` et que `unlimited_quota` est `false`, les requêtes de modèle avec cette clé sont rejetées comme quota épuisé. |
| `unlimited_quota` | boolean | Indique si la clé contourne les vérifications de quota restant. Définissez `true` uniquement lorsque la clé doit continuer à fonctionner même si `remain_quota` est `0`. |
| `model_limits_enabled` | boolean | Indique s'il faut restreindre cette clé à des modèles spécifiques. Lorsque `false`, `model_limits` est ignoré. |
| `model_limits` | string | model ID séparés par des virgules et autorisés par cette clé lorsque `model_limits_enabled` est `true`. Utilisez les model ID renvoyés par `/v1/models` ; utilisez une chaîne vide pour ne pas appliquer de restriction de modèle. |
| `allow_ips` | string or null | Liste d'autorisation IP facultative. Fournissez une seule chaîne JSON avec des entrées séparées par des caractères de nouvelle ligne (`\n`). Chaque entrée peut être une adresse IPv4 unique, une adresse IPv6 unique, un CIDR IPv4 ou un CIDR IPv6. Utilisez `null` ou `""` pour désactiver les restrictions IP. |
| `group` | string | Restriction facultative du groupe de compte. Utilisez une chaîne vide pour n'appliquer aucun groupe explicite. Les valeurs non vides doivent être disponibles pour le compte, sinon l'API renvoie `success: false`. |
| `cross_group_retry` | boolean | Indique si la nouvelle tentative intergroupe est activée pour le routage automatique des groupes. Cela n'a de sens que lorsque la clé utilise un groupe avec routage automatique. |
## Format de la liste d'autorisation
Pour autoriser plusieurs IP ou plages CIDR, envoyez-les comme une seule chaîne JSON avec `\n` entre les entrées :
```json theme={null}
{
"allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}
```
Cet exemple autorise une adresse IPv4, une plage CIDR IPv4 et une plage CIDR IPv6.
## OpenAPI
````yaml api/openapi/api-keys/update-api-key.openapi.json PUT /api/token/
openapi: 3.1.0
info:
title: Update API Key
version: 1.0.0
servers:
- url: https://api.cometapi.com
security:
- accessTokenAuth: []
paths:
/api/token/:
put:
summary: Update an API key
description: >-
Update an API key by sending its ID and editable fields in the JSON
body. This endpoint behaves like a full update: send fields you want to
preserve because omitted numeric, boolean, or string fields can be
reset.
operationId: updateApiKey
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateApiKeyRequest'
examples:
default:
summary: Update an API key
value:
id: 1234
name: production-renamed
status: 1
expired_time: -1
remain_quota: 100000
unlimited_quota: false
model_limits_enabled: false
model_limits: ''
allow_ips: null
group: ''
cross_group_retry: false
with_ip_allowlist:
summary: Configure an IP allowlist
description: >-
Use one JSON string and separate multiple IP or CIDR entries
with `\n`.
value:
id: 1234
name: production-renamed
status: 1
expired_time: -1
remain_quota: 100000
unlimited_quota: false
model_limits_enabled: false
model_limits: ''
allow_ips: |-
198.51.100.10
203.0.113.0/24
2001:db8::/32
group: ''
cross_group_retry: false
responses:
'200':
description: Updated API key record.
content:
application/json:
schema:
type: object
required:
- success
- message
- data
properties:
success:
type: boolean
message:
type: string
data:
$ref: '#/components/schemas/ApiKey'
examples:
success:
summary: Updated
value:
success: true
message: ''
data:
id: 1234
user_id: 5678
key: $COMETAPI_KEY
status: 1
name: production-renamed
created_time: 1766102400
accessed_time: 1766102400
expired_time: -1
remain_quota: 100000
unlimited_quota: false
model_limits_enabled: false
model_limits: ''
allow_ips: null
used_quota: 0
group: ''
cross_group_retry: false
name_too_long:
summary: Name too long
value:
success: false
message: token name is too long
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -X PUT https://api.cometapi.com/api/token/ \
-H "Authorization: your-access-token" \
-H "Content-Type: application/json" \
-d '{
"id": 1234,
"name": "production-renamed",
"status": 1,
"expired_time": -1,
"remain_quota": 100000,
"unlimited_quota": false,
"model_limits_enabled": false,
"model_limits": "",
"allow_ips": null,
"group": "",
"cross_group_retry": false
}'
- lang: curl
label: cURL with IP allowlist
source: |-
curl -X PUT https://api.cometapi.com/api/token/ \
-H "Authorization: your-access-token" \
-H "Content-Type: application/json" \
-d '{
"id": 1234,
"name": "production-renamed",
"status": 1,
"expired_time": -1,
"remain_quota": 100000,
"unlimited_quota": false,
"model_limits_enabled": false,
"model_limits": "",
"allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32",
"group": "",
"cross_group_retry": false
}'
components:
schemas:
UpdateApiKeyRequest:
type: object
required:
- id
properties:
id:
type: integer
description: >-
Numeric API key ID returned by the list endpoint. For updates, send
this value in the JSON body, not in the URL.
example: 1234
name:
type: string
maxLength: 50
description: >-
User-readable display name for the API key. The backend accepts up
to 50 Unicode characters; longer names return `success: false` with
`token name is too long`.
example: production
status:
type: integer
description: >-
Operational status for the key. `1` enables the key for model
requests, `2` disables it, `3` marks it expired, and `4` marks it
quota exhausted. Disabled, expired, or exhausted keys are rejected
by model endpoints.
enum:
- 1
- 2
- 3
- 4
example: 1
expired_time:
type: integer
description: >-
Unix timestamp in seconds when the key expires. Use `-1` for no
expiration. A past timestamp blocks model requests with this key.
example: -1
remain_quota:
type: integer
description: >-
Remaining quota to assign to the key in CometAPI internal quota
units. If this reaches `0` while `unlimited_quota` is `false`, model
requests with this key are rejected as quota exhausted.
example: 100000
unlimited_quota:
type: boolean
description: >-
Whether the key bypasses remaining-quota checks. Set `true` only
when the key should keep working even if `remain_quota` is `0`.
example: false
model_limits_enabled:
type: boolean
description: >-
Whether to restrict this key to specific models. When `true`, only
model IDs listed in `model_limits` are allowed. When `false`,
`model_limits` is ignored.
example: false
model_limits:
type: string
description: >-
Comma-separated model IDs allowed by this key when
`model_limits_enabled` is `true`. Use model IDs returned by
`/v1/models`, for example `,`. Use an empty
string for no model restriction.
example: ''
allow_ips:
type:
- string
- 'null'
description: >-
Optional IP allowlist. Provide one JSON string with entries
separated by newline characters (`\n`). Each entry can be a single
IPv4 address, single IPv6 address, IPv4 CIDR, or IPv6 CIDR. Example
for three allowlist entries:
`198.51.100.10\n203.0.113.0/24\n2001:db8::/32`. CometAPI compares
the model request client IP to this list. Use `null` or `""` to
disable IP restrictions.
example: |-
198.51.100.10
203.0.113.0/24
2001:db8::/32
group:
type: string
description: >-
Optional account group restriction. Use an empty string for no
explicit group restriction. Non-empty values must be available to
the account, or the API returns `success: false` with a `no access
to group` message.
example: ''
cross_group_retry:
type: boolean
description: >-
Whether cross-group retry is enabled for automatic group routing.
This is only meaningful when the key uses an auto-routed group such
as `auto`.
example: false
additionalProperties: false
ApiKey:
type: object
properties:
id:
type: integer
description: >-
Numeric API key ID. Use this value with the get, update, and delete
endpoints.
example: 1234
user_id:
type: integer
description: Account user ID that owns the key.
example: 5678
key:
type: string
description: >-
API key value returned by the management API. Treat it as a secret
and use it as `Authorization: Bearer $COMETAPI_KEY` for model
requests.
example: $COMETAPI_KEY
status:
type: integer
description: >-
Operational status for the key. `1` means enabled, `2` disabled, `3`
expired, and `4` exhausted. Only enabled keys are accepted by model
endpoints.
enum:
- 1
- 2
- 3
- 4
example: 1
name:
type: string
description: User-readable display name for the API key.
example: production
maxLength: 50
created_time:
type: integer
description: Unix timestamp in seconds when the key was created.
example: 1766102400
accessed_time:
type: integer
description: >-
Unix timestamp in seconds when the key was last used. Newly created
keys may show the creation time until first use.
example: 1766102400
expired_time:
type: integer
description: >-
Unix timestamp in seconds when the key expires. `-1` means no
expiration.
example: -1
remain_quota:
type: integer
description: >-
Remaining quota for this key in CometAPI internal quota units. When
this reaches `0` and `unlimited_quota` is `false`, model requests
are rejected as quota exhausted.
example: 100000
unlimited_quota:
type: boolean
description: Whether the key bypasses remaining-quota checks.
example: false
model_limits_enabled:
type: boolean
description: >-
Whether model restrictions are active for this key. When `false`,
`model_limits` is ignored.
example: false
model_limits:
type: string
description: >-
Comma-separated model IDs allowed by this key when
`model_limits_enabled` is `true`. Empty means no configured model
list.
example: ''
allow_ips:
type:
- string
- 'null'
description: >-
Optional IP allowlist stored as one newline-separated string. Each
entry can be a single IPv4 address, single IPv6 address, IPv4 CIDR,
or IPv6 CIDR. Example:
`198.51.100.10\n203.0.113.0/24\n2001:db8::/32`. `null` or `""` means
IP restrictions are disabled.
example: |-
198.51.100.10
203.0.113.0/24
2001:db8::/32
used_quota:
type: integer
description: Quota already consumed by this key in CometAPI internal quota units.
example: 0
group:
type: string
description: >-
Account group restriction for this key. Empty means no explicit
group restriction.
example: ''
cross_group_retry:
type: boolean
description: >-
Whether cross-group retry is enabled for automatic group routing.
This is only meaningful when the key uses an auto-routed group such
as `auto`.
example: false
additionalProperties: true
securitySchemes:
accessTokenAuth:
type: apiKey
in: header
name: Authorization
description: >-
Personal access token copied from CometAPI Console > Personal Settings.
Send the raw token value; do not prefix it with `Bearer`.
````