Aggiornare una chiave API - CometAPI Documentation

PUT

api

token

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
  }'

{
  "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
  }
}

Usa questo endpoint per aggiornare il nome, lo stato, la quota, la scadenza, le restrizioni dei modelli, l’allowlist IP e le impostazioni di gruppo di una chiave API.

Genera un personal access token in Console → Personal Settings, quindi invialo come valore raw dell’header Authorization. Non anteporre Bearer.

Questo endpoint usa PUT /api/token/ e l’id deve essere inserito nel body JSON. Invia i campi modificabili che vuoi mantenere; i campi numerici, booleani o stringa omessi possono essere reimpostati dall’aggiornamento.

Body della richiesta

Field	Type	Description
`id`	integer	Obbligatorio. ID della chiave API restituito da List API keys.
`name`	string	Nome visualizzato della chiave leggibile dall’utente. Deve contenere al massimo 50 caratteri.
`status`	integer	Stato operativo. `1` abilita la chiave per le richieste ai modelli. `2` la disabilita. `3` la contrassegna come scaduta. `4` la contrassegna come quota esaurita. Le chiavi disabilitate, scadute o esaurite vengono rifiutate dagli endpoint dei modelli.
`expired_time`	integer	Timestamp Unix in secondi che indica quando la chiave scade. Usa `-1` per nessuna scadenza. Un timestamp passato blocca le richieste ai modelli.
`remain_quota`	integer	Quota rimanente nelle unità di quota interne di CometAPI. Se raggiunge `0` e `unlimited_quota` è `false`, le richieste ai modelli con questa chiave vengono rifiutate come quota esaurita.
`unlimited_quota`	boolean	Indica se la chiave bypassa i controlli sulla quota residua. Imposta `true` solo quando la chiave deve continuare a funzionare anche se `remain_quota` è `0`.
`model_limits_enabled`	boolean	Indica se limitare questa chiave a modelli specifici. Quando è `false`, `model_limits` viene ignorato.
`model_limits`	string	ID dei modelli consentiti da questa chiave, separati da virgole, quando `model_limits_enabled` è `true`. Usa i model ID restituiti da `/v1/models`; usa una stringa vuota per nessuna restrizione sui modelli.
`allow_ips`	string or null	Allowlist IP facoltativa. Fornisci una singola stringa JSON con le voci separate da caratteri newline (`\n`). Ogni voce può essere un singolo indirizzo IPv4, un singolo indirizzo IPv6, un CIDR IPv4 o un CIDR IPv6. Usa `null` o `""` per disabilitare le restrizioni IP.
`group`	string	Restrizione facoltativa del gruppo account. Usa una stringa vuota per nessun gruppo esplicito. I valori non vuoti devono essere disponibili per l’account, altrimenti l’API restituisce `success: false`.
`cross_group_retry`	boolean	Indica se il retry cross-group è abilitato per il routing automatico del gruppo. Ha senso solo quando la chiave usa un gruppo con routing automatico.

Formato dell’allowlist

Per consentire più IP o intervalli CIDR, inviali come un’unica stringa JSON con \n tra le voci:

{
  "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}

Questo esempio consente un indirizzo IPv4, un intervallo CIDR IPv4 e un intervallo CIDR IPv6.

Autorizzazioni

Authorization

string

header

obbligatorio

Personal access token copied from CometAPI Console > Personal Settings. Send the raw token value; do not prefix it with Bearer.

Corpo

application/json

integer

obbligatorio

Numeric API key ID returned by the list endpoint. For updates, send this value in the JSON body, not in the URL.

Esempio:

1234

name

string

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.

Maximum string length: 50

Esempio:

"production"

status

enum<integer>

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.

Opzioni disponibili:

1,

2,

3,

4

Esempio:

1

expired_time

integer

Unix timestamp in seconds when the key expires. Use -1 for no expiration. A past timestamp blocks model requests with this key.

Esempio:

-1

remain_quota

integer

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.

Esempio:

100000

unlimited_quota

boolean

Whether the key bypasses remaining-quota checks. Set true only when the key should keep working even if remain_quota is 0.

Esempio:

false

model_limits_enabled

boolean

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.

Esempio:

false

model_limits

string

Comma-separated model IDs allowed by this key when model_limits_enabled is true. Use model IDs returned by /v1/models, for example <model-id-1>,<model-id-2>. Use an empty string for no model restriction.

Esempio:

""

allow_ips

string | null

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.

Esempio:

"198.51.100.10\n203.0.113.0/24\n2001:db8::/32"

group

string

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.

Esempio:

""

cross_group_retry

boolean

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.

Esempio:

false

Risposta

200 - application/json

Updated API key record.

success

boolean

obbligatorio

message

string

obbligatorio

data

object

obbligatorio

Show child attributes

Eliminare una chiave API

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
  }'

{
  "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
  }
}

Documentation Index

​Body della richiesta

​Formato dell’allowlist

Autorizzazioni

Corpo

Risposta

Body della richiesta

Formato dell’allowlist