v2

latestOpenAPI 3.1.02026-07-2675166192.8 KB
admin-clusters

List Clusters

List non-terminated clusters (auto-scoped to the caller's grants).

get/api/admin/clusters

Query parameters

vaultEnabledboolean nullable

If true, return only vault-enabled clusters; if false, only non-vault-enabled. Omit to include both.

If true, return only vault-enabled clusters; if false, only non-vault-enabled. Omit to include both.

searchstring nullable

Case-insensitive substring match against cluster name or id.

Case-insensitive substring match against cluster name or id.

offsetinteger

Number of items to skip.

Number of items to skip.

limitinteger

Max items to return (1-100).

Max items to return (1-100).

detailedboolean

If true, populate nodes for each cluster (one entry per pod). Otherwise only the controller connection is returned.

If true, populate nodes for each cluster (one entry per pod). Otherwise only the controller connection is returned.

Response

Successful Response

total_countinteger

Total number of items available in the dataset

offsetinteger

Number of items to skip before starting to collect the result set

limitinteger

Maximum number of items to return

statusstring nullable

Response status

All 75 operations