Cycles

Appearance

List API keys​

GET
/v1/admin/api-keys

Returns API keys, optionally filtered by tenant. Full key secrets are never returned, only prefixes and metadata.
AUTHORIZATION: - AdminKeyAuth: admin operator lists keys. tenant_id is OPTIONAL.
When omitted, returns keys across all tenants (cursor-paginated).
When provided, scopes the result to that tenant.

Authorizations​

AdminKeyAuth

Administrative API key with full system access. Also accepted as an alternative to ApiKeyAuth on an explicit per-operation allowlist — the authoritative list is the union of operations whose security: block declares AdminKeyAuth (consult per-operation security blocks rather than this prose, which has historically drifted as the dual-auth surface expanded). When using AdminKeyAuth on list or fund endpoints, a tenant scoping parameter (typically tenant or tenant_id) is required for scoping (400 if missing) — the per-operation description specifies which. Lookup-style endpoints that uniquely identify a resource by non-tenant key (e.g. GET /v1/admin/budgets/lookup, where the (scope, unit) pair is unique) do NOT require a tenant parameter. Allowlisting is per-operation (exact method:path matching — no prefix matching, no wildcards) so new endpoints do not accidentally inherit admin-accessible status.

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

Parameters​

Query Parameters

tenant_id

Optional tenant filter. When omitted under AdminKeyAuth, returns keys across all tenants. When provided, scopes the result to the specified tenant.

Type
string
status
Type
string
Valid values
"ACTIVE""REVOKED""EXPIRED"
search

Free-text case-insensitive substring match. Matches across: key_id, name. Combined with other filter params using AND semantics. Additive parameter — servers that don't recognize it MUST ignore without error (additive-parameter guarantee). Empty string MUST be treated as absent. Max length 128 characters; longer values MUST be rejected with HTTP 400.

Type
string
Max Length
128
sort_by

Sort key. When provided, results are returned in the requested order and the returned cursor encodes the sort key so "Load more" continues in sort order. When omitted, servers use their existing default ordering. Servers that don't recognize the parameter MUST ignore it without error (additive-parameter guarantee).

Type
string
Valid values
"key_id""name""tenant_id""status""created_at""expires_at"
Default
"created_at"
sort_dir

Sort direction. Default descending.

Type
string
Valid values
"asc""desc"
Default
"desc"
cursor
Type
string
limit
Type
integer
Default
50

Responses​

API key list

application/json
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
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI