Cycles

Appearance

List all tenants​

GET
/v1/admin/tenants

Returns paginated list of all tenants. Useful for admin dashboards and tenant discovery.

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

status
Type
string
Valid values
"ACTIVE""SUSPENDED""CLOSED"
parent_tenant_id
Type
string
observe_mode

Optional. Filter by tenant observe_mode value. Only meaningful on servers that implement the observe_mode extension (v0.1.26). Servers that don't recognize this parameter MUST ignore it without error (additive-parameter guarantee).

Type
string
search

Free-text case-insensitive substring match. Matches across: tenant_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
"tenant_id""name""status""created_at"
Default
"created_at"
sort_dir

Sort direction. Default descending.

Type
string
Valid values
"asc""desc"
Default
"desc"
cursor
Type
string
limit
Type
integer
Minimum
1
Maximum
100
Default
50

Responses​

Tenant list

application/json
JSON
{
  
"tenants": [
  
  
{
  
  
  
"tenant_id": "string",
  
  
  
"name": "string",
  
  
  
"status": "string",
  
  
  
"parent_tenant_id": "string",
  
  
  
"default_commit_overage_policy": "string",
  
  
  
"default_reservation_ttl_ms": 60000,
  
  
  
"max_reservation_ttl_ms": 3600000,
  
  
  
"max_reservation_extensions": 10,
  
  
  
"reservation_expiry_policy": "AUTO_RELEASE",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string",
  
  
  
"suspended_at": "string",
  
  
  
"closed_at": "string"
  
  
}
  
],
  
"next_cursor": "string",
  
"has_more": true
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI