Skip to main content
POST
List Clusters

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer | null
Required range: 1 <= x <= 1000
page_size
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
page
integer | null
Required range: x >= 1
cursor
string | null
include_total
boolean
default:false

Body

application/json

Request model for listing clusters.

Inherits body-level limit/page_size/offset/page (BACKE-2846) — body values win over query pagination via merge_body_pagination.

limit
integer | null

Page size. A body value wins over the limit query param.

Required range: 1 <= x <= 1000
page_size
integer | null

Alias for limit (page size). If both are given, limit wins.

Required range: 1 <= x <= 1000
offset
integer | null

Number of results to skip (legacy, use cursor instead). A body value wins over the offset query param.

Required range: 0 <= x <= 10000
page
integer | null

1-indexed page number. Folds to offset = (page-1) * limit. If both page and offset are given, offset wins.

Required range: x >= 1
filters
LogicalOperator · object | null

Filters to apply when listing clusters

sort
SortOption · object | null

Sort options for the results (single-column, legacy)

sorts
Sorts · object[] | null

Sort options as a list of {field, direction} — the shape Studio datatables and the retriever list send. The first entry is the primary sort. Takes precedence over the singular sort.

search
string | null

Search term for wildcard search across cluster_id, cluster_name, description, and other text fields

Response

Successful Response

Response model for listing clusters.

results
ClusterMetadata · object[]
required

List of cluster metadata

pagination
PaginationResponse · object
required

Pagination information

total_count
integer
required

Total number of clusters matching the query

stats
ClusterListStats · object | null

Aggregate statistics across all clusters in the result