Skip to main content
GET
List clusters

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string
required

The Organization's unique ID.

Query Parameters

names
string[]

A list of names for Clusters to filter by. The API returns details only for the specified Clusters.

provider
enum<string>

The cloud provider to list clusters for. Clusters from other providers will be filtered out of the results.

Available options:
AWS,
AZURE,
GCP
offset
integer
default:0

The number of results to skip before returning values.

Required range: x >= 0
limit
integer
default:20

The maximum number of results to return.

Required range: 0 <= x <= 1000
sorts
enum<string>[]

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Available options:
name:asc,
name:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

clusters
object[]
required

The list of clusters in the current page.

limit
integer
required

The maximum number of clusters in one page.

Example:

10

offset
integer
required

The offset of the current page of clusters.

Example:

0

totalCount
integer
required

The total number of clusters.

Example:

100