Bir API key güncelleme - 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
  }
}

Bu endpoint’i kullanarak bir API key’in adını, durumunu, kotasını, sona erme süresini, model kısıtlamalarını, IP allowlist’ini ve grup ayarlarını güncelleyebilirsiniz.

Console → Personal Settings üzerinden bir personal access token oluşturun, ardından bunu ham Authorization header değeri olarak gönderin. Başına Bearer eklemeyin.

Bu endpoint PUT /api/token/ kullanır ve id JSON body içinde yer almalıdır. Korumak istediğiniz düzenlenebilir alanları gönderin; gönderilmeyen sayısal, boolean veya string alanlar güncelleme sırasında sıfırlanabilir.

Request body

Field	Type	Description
`id`	integer	Zorunlu. List API keys tarafından döndürülen API key ID’si.
`name`	string	Key için kullanıcı tarafından okunabilir görünen ad. 50 karakter veya daha az olmalıdır.
`status`	integer	Operasyonel durum. `1`, key’i model istekleri için etkinleştirir. `2`, devre dışı bırakır. `3`, süresi dolmuş olarak işaretler. `4`, kotası tükenmiş olarak işaretler. Devre dışı, süresi dolmuş veya kotası tükenmiş key’ler model endpoint’leri tarafından reddedilir.
`expired_time`	integer	Key’in süresinin dolacağı zamanı belirten saniye cinsinden Unix timestamp. Süresiz kullanım için `-1` kullanın. Geçmiş bir timestamp model isteklerini engeller.
`remain_quota`	integer	CometAPI dahili kota birimleri cinsinden kalan kota. Bu değer `0` olursa ve `unlimited_quota` değeri `false` ise, bu key ile yapılan model istekleri kotası tükenmiş olarak reddedilir.
`unlimited_quota`	boolean	Key’in kalan kota kontrollerini atlayıp atlamayacağı. Key’in `remain_quota` değeri `0` olsa bile çalışmaya devam etmesi gerekiyorsa yalnızca `true` olarak ayarlayın.
`model_limits_enabled`	boolean	Bu key’in belirli modellerle sınırlandırılıp sınırlandırılmayacağı. `false` olduğunda `model_limits` yok sayılır.
`model_limits`	string	`model_limits_enabled` değeri `true` olduğunda bu key için izin verilen, virgülle ayrılmış model ID’leri. `/v1/models` tarafından döndürülen model ID’lerini kullanın; model kısıtlaması olmaması için boş string kullanın.
`allow_ips`	string or null	İsteğe bağlı IP allowlist. Girdileri yeni satır karakterleriyle (`\n`) ayrılmış tek bir JSON string olarak sağlayın. Her girdi tek bir IPv4 adresi, tek bir IPv6 adresi, IPv4 CIDR veya IPv6 CIDR olabilir. IP kısıtlamalarını devre dışı bırakmak için `null` veya `""` kullanın.
`group`	string	İsteğe bağlı hesap grup kısıtlaması. Açık bir grup belirtmemek için boş string kullanın. Boş olmayan değerler hesap için kullanılabilir olmalıdır, aksi halde API `success: false` döndürür.
`cross_group_retry`	boolean	Otomatik grup yönlendirmesi için cross-group retry’nin etkin olup olmadığı. Bu yalnızca key otomatik yönlendirilen bir grup kullandığında anlamlıdır.

Allowlist biçimi

Birden fazla IP veya CIDR aralığına izin vermek için, bunları girdiler arasında \n olacak şekilde tek bir JSON string olarak gönderin:

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

Bu örnek bir IPv4 adresine, bir IPv4 CIDR aralığına ve bir IPv6 CIDR aralığına izin verir.

Yetkilendirmeler

Authorization

string

header

gerekli

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

Gövde

application/json

integer

gerekli

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

Örnek:

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

Örnek:

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

Mevcut seçenekler:

1,

2,

3,

4

Örnek:

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.

Örnek:

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

Örnek:

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.

Örnek:

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.

Örnek:

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.

Örnek:

""

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.

Örnek:

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

Örnek:

""

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.

Örnek:

false

Yanıt

200 - application/json

Updated API key record.

success

boolean

gerekli

message

string

gerekli

data

object

gerekli

Show child attributes

Bir API anahtarını silin

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 biçimi

Yetkilendirmeler

Gövde

Yanıt

Request body

Allowlist biçimi