GRGlobalRouter Docs
Console

API keys / GET

List API keys

Lists API keys owned by the current calling key's owner.

Endpoints

Mobile only shows the endpoint list. View parameter details and examples on desktop.

MethodEndpointDescription
GET/api/v1/keyReads masked information for the API key used by the current request.
GET/api/v1/keysLists API keys owned by the current calling key's owner.
GET/api/v1/keys/{key_ref}Reads masked information for one API key by key reference.
POST/api/v1/keysCreates a new tenant API key.
PATCH/api/v1/keys/{key_ref}Updates an API key's name, scopes, model ranges, source IPs, or rate limit.
DELETE/api/v1/keys/{key_ref}Revokes an API key.
GET/api/v1/keys

Disabled keys are omitted by default.

Back to API keys endpoint list

Request parameters

FieldTypeRequiredDescription
include_disabledbooleanNoWhether to include disabled keys; defaults to false.

Response fields

FieldTypeRequiredDescription
dataobject[]YesAPI key list.
data[].idstringYesAPI key record ID.
data[].hashstringYesKey 哈希引用，不是明文 Key。
data[].tenant_idstringYesKey 所属租户 ID。
data[].namestringYesKey name.
data[].key_prefixstringYesKey 前缀，用于识别与排查。
data[].scopesstring[]YesScopes.
data[].statusstringYesKey status.
data[].allowed_modelsstring[]NoModel allowlist.
data[].blocked_modelsstring[]NoModel blocklist.
data[].allowed_ipsstring[]NoSource IP allowlist.
data[].rate_limit_per_minuteintegerNoPer-minute rate limit.
data[].expires_atstringNo过期时间。
data[].created_atstringNocreate时间。
data[].last_used_atstringNo最近使用时间。