Version 2.1.1792967583 · latest Download OpenAPI Markdown

API keys

API keys of the current user. The plaintext key is returned only once at creation, and scopes can be limited per domain.

api-keysUser accountsAuthentication: User4 endpoints

List API keys

GET/api/v2/api-keys

Authentication: User

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`

POST/api/v2/api-keys

Authentication: User

Field	Type	Required	Description
allow_ips	ApiKeyAllowIps	—	Caller IP allowlist (single IPs only, at most 200); empty means no restriction. Calls from other IPs get 401 as invalid credentials
expires_at	string	—	Expires at
name	string	Required	Name
scopes	string[]	Required	Granted scopes, same values as scopes at creation

PUT/api/v2/api-keys/{id}

Authentication: User

Field	Type	Required	Description
allow_ips	ApiKeyAllowIps	—	Caller IP allowlist (single IPs only, at most 200); empty means no restriction. Calls from other IPs get 401 as invalid credentials
reset	boolean	—	When true, issue a new key; the old one stops working at once

DELETE/api/v2/api-keys/{id}

Authentication: User

Field	Type	Required	Description
allow_ips	ApiKeyAllowIps	—	Caller IP allowlist (single IPs only, at most 200); empty means no restriction. Calls from other IPs get 401 as invalid credentials
created_at	string	—	Created at read-only
expires_at	string	—	Expires at
id	integer	—	Record ID read-only
last_used_at	string	—	Time of last use; null if never used
name	string	—	Name
prefix	string	—	First few characters of the plaintext key, for recognition
reset	boolean	—	When true, issue a new key; the old one stops working at once
scopes	string[]	—	Granted scopes, same values as scopes at creation
secret	string	—	Plaintext key (the X-API-Key value), returned only once at creation; only a hash is stored
updated_at	string	—	Updated at read-only