List API keys

GET

/v1/admin/api-keys

Returns keys for a tenant. Full key secrets are never returned, only prefixes and metadata.

Authorizations

AdminKeyAuth

Administrative API key with full system access

Type

API Key (header: X-Admin-API-Key)

Parameters

Query Parameters

tenant_id*

Type

string

Required

status

Type

string

Valid values

"ACTIVE""REVOKED""EXPIRED"

cursor

Type

string

limit

Type

integer

Default

50

Responses

API key list

Content-Type

application/json

{

  

"keys": [

  

  

{

  

  

  

"key_id": "string",

  

  

  

"tenant_id": "string",

  

  

  

"key_prefix": "string",

  

  

  

"name": "string",

  

  

  

"description": "string",

  

  

  

"permissions": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"scope_filter": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"status": "string",

  

  

  

"created_at": "string",

  

  

  

"last_used_at": "string",

  

  

  

"expires_at": "string",

  

  

  

"revoked_at": "string",

  

  

  

"revoked_reason": "string",

  

  

  

"metadata": {

  

  

  

  

"additionalProperties": "string"

  

  

  

}

  

  

}

  

],

  

"next_cursor": "string",

  

"has_more": true

}

GET

/v1/admin/api-keys

Playground

Authorization

AdminKeyAuth

Variables

Key

Value

tenant_id*

status

cursor

limit

Samples

Powered by VitePress OpenAPI