Skip to main content
GET
List Clusters
string
Filter by the namespace where the ClusterRegistration lives. Omit it to list every namespace.
integer
default:"1"
Page number
integer
default:"20"
Items per page (maximum 100)
Minimum role: viewer. There are no status or region filters; use Federation Clusters to filter by tier. Zero-valued and empty fields are omitted (connected is always present).

Authorizations

X-API-Key
string
header
required

API key sent in the X-API-Key header. Keys are read from the Secret chatcli-operator-secrets, key api-keys (fallback: ConfigMap chatcli-operator-config, key api-keys) in the operator namespace, as a YAML list of {key, role, name, description} (name is the identity recorded on approval decisions); the operator chart creates it only with apiKeys.create: true. Roles: viewer < operator < admin — any other role string is denied everywhere. Changes are picked up within about 30 seconds; deleting both the Secret and the ConfigMap revokes every key. With no keys configured every /api/ call returns 401, unless CHATCLI_OPERATOR_DEV_MODE=true, which grants admin without a key (development only).

Query Parameters

namespace
string

Kubernetes namespace. Empty means all namespaces.

page
integer
default:1

Page number (1-based). Invalid values fall back to 1.

Required range: x >= 1
pageSize
integer
default:20

Items per page. Values above 100 are capped at 100.

Required range: 1 <= x <= 100

Response

Paginated list of clusters

apiVersion
string
Example:

"v1"

kind
string
Example:

"ClusterRegistrationList"

metadata
object
items
object[]