Actualizar una API key

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 este endpoint para actualizar el nombre, estado, cuota, vencimiento, restricciones de modelos, lista permitida de IP y configuración de grupo de una API key.

Genera un personal access token en Console → Personal Settings, luego envíalo como el valor sin procesar del encabezado Authorization. No le antepongas Bearer.

Este endpoint usa PUT /api/token/, y el id pertenece al cuerpo JSON. Envía los campos editables que quieras conservar; los campos numéricos, booleanos o de cadena omitidos pueden restablecerse con la actualización.

Cuerpo de la solicitud

Field	Type	Description
`id`	integer	Obligatorio. ID de la API key devuelto por List API keys.
`name`	string	Nombre para mostrar legible por el usuario para la key. Debe tener 50 caracteres o menos.
`status`	integer	Estado operativo. `1` habilita la key para solicitudes de modelo. `2` la deshabilita. `3` la marca como expirada. `4` la marca con la cuota agotada. Las keys deshabilitadas, expiradas o agotadas son rechazadas por los endpoints de modelo.
`expired_time`	integer	Marca de tiempo Unix en segundos cuando expira la key. Usa `-1` para que no expire. Una marca de tiempo pasada bloquea las solicitudes de modelo.
`remain_quota`	integer	Cuota restante en unidades internas de cuota de CometAPI. Si esto llega a `0` y `unlimited_quota` es `false`, las solicitudes de modelo con esta key se rechazan por cuota agotada.
`unlimited_quota`	boolean	Indica si la key omite las comprobaciones de cuota restante. Establece `true` solo cuando la key deba seguir funcionando incluso si `remain_quota` es `0`.
`model_limits_enabled`	boolean	Indica si se debe restringir esta key a modelos específicos. Cuando es `false`, `model_limits` se ignora.
`model_limits`	string	model IDs separados por comas permitidos por esta key cuando `model_limits_enabled` es `true`. Usa los model IDs devueltos por `/v1/models`; usa una cadena vacía para no aplicar restricción de modelo.
`allow_ips`	string or null	Lista permitida de IP opcional. Proporciona una cadena JSON con entradas separadas por caracteres de nueva línea (`\n`). Cada entrada puede ser una sola dirección IPv4, una sola dirección IPv6, un CIDR IPv4 o un CIDR IPv6. Usa `null` o `""` para desactivar las restricciones de IP.
`group`	string	Restricción opcional de grupo de cuenta. Usa una cadena vacía para no establecer un grupo explícito. Los valores no vacíos deben estar disponibles para la cuenta, o la API devuelve `success: false`.
`cross_group_retry`	boolean	Indica si el reintento entre grupos está habilitado para el enrutamiento automático de grupos. Esto solo tiene sentido cuando la key usa un grupo con enrutamiento automático.

Formato de la lista permitida

Para permitir múltiples IP o rangos CIDR, envíalos como una cadena JSON con \n entre las entradas:

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

Este ejemplo permite una dirección IPv4, un rango CIDR IPv4 y un rango CIDR IPv6.

Autorizaciones

Authorization

string

header

requerido

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

Cuerpo

application/json

integer

requerido

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

Ejemplo:

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

Ejemplo:

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

Opciones disponibles:

1,

2,

3,

4

Ejemplo:

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.

Ejemplo:

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

Ejemplo:

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.

Ejemplo:

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.

Ejemplo:

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.

Ejemplo:

""

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.

Ejemplo:

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

Ejemplo:

""

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.

Ejemplo:

false

Respuesta

200 - application/json

Updated API key record.

success

boolean

requerido

message

string

requerido

data

object

requerido

Show child attributes

Eliminar una API key

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

Moderación de contenido

Claves API

Cuerpo de la solicitud

Formato de la lista permitida

Autorizaciones

Cuerpo

Respuesta

​Cuerpo de la solicitud

​Formato de la lista permitida

Autorizaciones

Cuerpo

Respuesta

Cuerpo de la solicitud

Formato de la lista permitida