Clusters
Search clusters
User must have the ENVIRONMENT_CLUSTER[READ] permission.
get/clusters
Query parameters
pageinteger
The page number for pagination.
perPageinteger
The number of items per page for pagination.
sortBy'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'
Example:name
Possibility to sort Cluster results by field. Can be ascending or descending with minus '-' prefix. By default, it is sorted by name.
qstring
Example:my cluster
A search query to filter clusters.
type'KAFKA_CLUSTER_STANDALONE' | 'KAFKA_CLUSTER' | 'KAFKA_VIRTUAL_CLUSTER'
Filter clusters by type.
lifecycleStatestring[]
Filter clusters by lifecycle state. Repeat the parameter to match several states.
Response
Page of clusters