latestOpenAPI 3.1.02026-08-20118225278.9 KB

3d3868828a78

admin-inventory

List Clusters

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

get/api/admin/inventory/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, slug, or id.

Case-insensitive substring match against cluster name, slug, 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).

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