Een API-sleutel bijwerken - 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
  }
}

Gebruik dit endpoint om de naam, status, quota, vervaldatum, modelbeperkingen, IP-allowlist en groepsinstellingen van een API-sleutel bij te werken.

Genereer een personal access token via Console → Personal Settings en verstuur het vervolgens als de onbewerkte waarde van de Authorization-header. Voeg er geen Bearer-prefix aan toe.

Dit endpoint gebruikt PUT /api/token/, en de id hoort in de JSON-body. Verstuur de bewerkbare velden die je wilt behouden; weggelaten numerieke, booleaanse of stringvelden kunnen door de update worden gereset.

Request body

Field	Type	Description
`id`	integer	Verplicht. API-sleutel-ID geretourneerd door List API keys.
`name`	string	Voor gebruikers leesbare weergavenaam voor de sleutel. Moet 50 tekens of minder zijn.
`status`	integer	Operationele status. `1` schakelt de sleutel in voor modelverzoeken. `2` schakelt deze uit. `3` markeert deze als verlopen. `4` markeert deze als quota uitgeput. Uitgeschakelde, verlopen of uitgeputte sleutels worden door model-endpoints afgewezen.
`expired_time`	integer	Unix-timestamp in seconden waarop de sleutel verloopt. Gebruik `-1` voor geen vervaldatum. Een timestamp in het verleden blokkeert modelverzoeken.
`remain_quota`	integer	Resterend quota in interne quota-eenheden van CometAPI. Als dit `0` bereikt en `unlimited_quota` `false` is, worden modelverzoeken met deze sleutel afgewezen als quota uitgeput.
`unlimited_quota`	boolean	Of de sleutel controles op resterend quota omzeilt. Stel in op `true` alleen wanneer de sleutel moet blijven werken, zelfs als `remain_quota` `0` is.
`model_limits_enabled`	boolean	Of deze sleutel moet worden beperkt tot specifieke modellen. Wanneer `false`, wordt `model_limits` genegeerd.
`model_limits`	string	Door komma’s gescheiden model ID’s die door deze sleutel zijn toegestaan wanneer `model_limits_enabled` `true` is. Gebruik model ID’s geretourneerd door `/v1/models`; gebruik een lege string voor geen modelbeperking.
`allow_ips`	string or null	Optionele IP-allowlist. Geef één JSON-string op met items gescheiden door newline-tekens (`\n`). Elk item kan een enkel IPv4-adres, enkel IPv6-adres, IPv4-CIDR of IPv6-CIDR zijn. Gebruik `null` of `""` om IP-beperkingen uit te schakelen.
`group`	string	Optionele beperking op accountgroep. Gebruik een lege string als er geen expliciete groep is. Niet-lege waarden moeten beschikbaar zijn voor het account, anders retourneert de API `success: false`.
`cross_group_retry`	boolean	Of cross-group retry is ingeschakeld voor automatische groeproutering. Dit is alleen relevant wanneer de sleutel een automatisch gerouteerde groep gebruikt.

Allowlist-indeling

Om meerdere IP’s of CIDR-bereiken toe te staan, verstuur je deze als één JSON-string met \n tussen de items:

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

Dit voorbeeld staat één IPv4-adres, één IPv4-CIDR-bereik en één IPv6-CIDR-bereik toe.

Autorisaties

Authorization

string

header

vereist

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

Body

application/json

integer

vereist

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

Voorbeeld:

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

Voorbeeld:

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

Beschikbare opties:

1,

2,

3,

4

Voorbeeld:

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.

Voorbeeld:

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

Voorbeeld:

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.

Voorbeeld:

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.

Voorbeeld:

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.

Voorbeeld:

""

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.

Voorbeeld:

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

Voorbeeld:

""

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.

Voorbeeld:

false

Respons

200 - application/json

Updated API key record.

success

boolean

vereist

message

string

vereist

data

object

vereist

Show child attributes

Een API-sleutel verwijderen

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

​Request body

​Allowlist-indeling

Autorisaties

Body

Respons

Request body

Allowlist-indeling