Oppdater en API-nøkkel - 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
  }
}

Bruk dette endepunktet for å oppdatere en API-nøkkels navn, status, kvote, utløp, modelbegrensninger, IP-tillatelsesliste og gruppeinnstillinger.

Generer en personal access token i Console → Personal Settings, og send den deretter som den rå Authorization-headerverdien. Ikke sett Bearer foran.

Dette endepunktet bruker PUT /api/token/, og id hører hjemme i JSON-bodyen. Send de redigerbare feltene du vil bevare; utelatte numeriske, boolske eller strengfelt kan bli tilbakestilt av oppdateringen.

Request body

Field	Type	Description
`id`	integer	Påkrevd. API-nøkkel-ID returnert av List API keys.
`name`	string	Lesbart visningsnavn for nøkkelen. Må være 50 tegn eller færre.
`status`	integer	Operativ status. `1` aktiverer nøkkelen for model-forespørsler. `2` deaktiverer den. `3` markerer den som utløpt. `4` markerer den som kvote oppbrukt. Deaktiverte, utløpte eller oppbrukte nøkler blir avvist av model-endepunkter.
`expired_time`	integer	Unix-tidsstempel i sekunder for når nøkkelen utløper. Bruk `-1` for ingen utløpstid. Et tidsstempel i fortiden blokkerer model-forespørsler.
`remain_quota`	integer	Gjenstående kvote i CometAPI interne kvoteenheter. Hvis denne når `0` og `unlimited_quota` er `false`, blir model-forespørsler med denne nøkkelen avvist som kvote oppbrukt.
`unlimited_quota`	boolean	Om nøkkelen omgår kontroller av gjenstående kvote. Sett `true` bare når nøkkelen skal fortsette å fungere selv om `remain_quota` er `0`.
`model_limits_enabled`	boolean	Om denne nøkkelen skal begrenses til bestemte modeller. Når `false`, ignoreres `model_limits`.
`model_limits`	string	Kommaseparerte model ID-er som er tillatt av denne nøkkelen når `model_limits_enabled` er `true`. Bruk model ID-er returnert av `/v1/models`; bruk en tom streng for ingen modelbegrensning.
`allow_ips`	string or null	Valgfri IP-tillatelsesliste. Oppgi én JSON-streng med oppføringer separert av linjeskifttegn (`\n`). Hver oppføring kan være én enkelt IPv4-adresse, én enkelt IPv6-adresse, IPv4 CIDR eller IPv6 CIDR. Bruk `null` eller `""` for å deaktivere IP-begrensninger.
`group`	string	Valgfri begrensning til kontogruppe. Bruk en tom streng for ingen eksplisitt gruppe. Ikke-tomme verdier må være tilgjengelige for kontoen, ellers returnerer API-et `success: false`.
`cross_group_retry`	boolean	Om cross-group retry er aktivert for automatisk grupperuting. Dette er bare meningsfullt når nøkkelen bruker en automatisk rutet gruppe.

Allowlist format

For å tillate flere IP-er eller CIDR-områder, send dem som én JSON-streng med \n mellom oppføringene:

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

Dette eksempelet tillater én IPv4-adresse, ett IPv4 CIDR-område og ett IPv6 CIDR-område.

Autorisasjoner

Authorization

string

header

påkrevd

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

Kropp

application/json

integer

påkrevd

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

Eksempel:

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

Eksempel:

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

Tilgjengelige alternativer:

1,

2,

3,

4

Eksempel:

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.

Eksempel:

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

Eksempel:

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.

Eksempel:

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.

Eksempel:

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.

Eksempel:

""

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.

Eksempel:

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

Eksempel:

""

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.

Eksempel:

false

Svar

200 - application/json

Updated API key record.

success

boolean

påkrevd

message

string

påkrevd

data

object

påkrevd

Show child attributes

Slett en API-nøkkel

Forrige

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 format

Autorisasjoner

Kropp

Svar

Request body

Allowlist format