Memperbarui API key - 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
  }
}

Gunakan endpoint ini untuk memperbarui nama API key, status, kuota, kedaluwarsa, pembatasan model, allowlist IP, dan pengaturan grup.

Buat personal access token di Console → Personal Settings, lalu kirimkan sebagai nilai header Authorization mentah. Jangan tambahkan prefiks Bearer.

Endpoint ini menggunakan PUT /api/token/, dan id harus ditempatkan di body JSON. Kirim field yang dapat diedit yang ingin Anda pertahankan; field numerik, boolean, atau string yang dihilangkan dapat direset oleh pembaruan.

Body permintaan

Field	Type	Description
`id`	integer	Wajib. ID API key yang dikembalikan oleh List API keys.
`name`	string	Nama tampilan yang dapat dibaca pengguna untuk key. Harus terdiri dari 50 karakter atau kurang.
`status`	integer	Status operasional. `1` mengaktifkan key untuk permintaan model. `2` menonaktifkannya. `3` menandainya kedaluwarsa. `4` menandainya kuota habis. Key yang dinonaktifkan, kedaluwarsa, atau habis kuotanya akan ditolak oleh endpoint model.
`expired_time`	integer	Unix timestamp dalam detik saat key kedaluwarsa. Gunakan `-1` untuk tanpa kedaluwarsa. Timestamp yang sudah lewat akan memblokir permintaan model.
`remain_quota`	integer	Sisa kuota dalam unit kuota internal CometAPI. Jika nilainya mencapai `0` dan `unlimited_quota` bernilai `false`, permintaan model dengan key ini akan ditolak karena kuota habis.
`unlimited_quota`	boolean	Apakah key melewati pemeriksaan sisa kuota. Setel `true` hanya jika key harus tetap berfungsi meskipun `remain_quota` adalah `0`.
`model_limits_enabled`	boolean	Apakah key ini dibatasi ke model tertentu. Saat `false`, `model_limits` diabaikan.
`model_limits`	string	model ID yang dipisahkan koma dan diizinkan oleh key ini saat `model_limits_enabled` bernilai `true`. Gunakan model ID yang dikembalikan oleh `/v1/models`; gunakan string kosong untuk tanpa pembatasan model.
`allow_ips`	string or null	Allowlist IP opsional. Berikan satu string JSON dengan entri yang dipisahkan oleh karakter baris baru (`\n`). Setiap entri dapat berupa satu alamat IPv4, satu alamat IPv6, IPv4 CIDR, atau IPv6 CIDR. Gunakan `null` atau `""` untuk menonaktifkan pembatasan IP.
`group`	string	Pembatasan grup akun opsional. Gunakan string kosong untuk tanpa grup eksplisit. Nilai yang tidak kosong harus tersedia untuk akun, atau API akan mengembalikan `success: false`.
`cross_group_retry`	boolean	Apakah retry lintas grup diaktifkan untuk perutean grup otomatis. Ini hanya bermakna saat key menggunakan grup dengan perutean otomatis.

Format allowlist

Untuk mengizinkan beberapa IP atau rentang CIDR, kirimkan semuanya sebagai satu string JSON dengan \n di antara entri:

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

Contoh ini mengizinkan satu alamat IPv4, satu rentang IPv4 CIDR, dan satu rentang IPv6 CIDR.

Otorisasi

Authorization

string

header

wajib

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

Body

application/json

integer

wajib

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

Contoh:

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

Contoh:

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

Opsi yang tersedia:

1,

2,

3,

4

Contoh:

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.

Contoh:

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

Contoh:

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.

Contoh:

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.

Contoh:

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.

Contoh:

""

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.

Contoh:

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

Contoh:

""

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.

Contoh:

false

Respons

200 - application/json

Updated API key record.

success

boolean

wajib

message

string

wajib

data

object

wajib

Show child attributes

Hapus API key

Sebelumnya

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 permintaan

​Format allowlist

Otorisasi

Body

Respons

Body permintaan

Format allowlist