Platform API ReferenceCluster

List clusters

List clusters in an Organization.

Path parameters

organizationIdstringRequired
The Organization's unique ID.

Headers

AuthorizationstringRequired

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

Query parameters

nameslist of stringsOptional
A list of names for Clusters to filter by. The API returns details only for the specified Clusters.
providerenumOptional
The cloud provider to list clusters for. Clusters from other providers will be filtered out of the results.
Allowed values:
offsetintegerOptional>=0Defaults to 0
The number of results to skip before returning values.
limitintegerOptional>=0<=1000Defaults to 20
The maximum number of results to return.
sortslist of enumsOptional

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

Response

OK
clusterslist of objects
The list of clusters in the current page.
limitinteger
The maximum number of clusters in one page.
offsetinteger
The offset of the current page of clusters.
totalCountinteger
The total number of clusters.

Errors