List clusters
Returns the organization’s clusters, a page at a time.
/clusterAuthorizationBearer token (JWT) · headerrequiredJWT token passed in the Authorization header using the Bearer <token> format.
page[limit]integerMaximum number of records to return
page[number]integerPage number
filter[with_deleted]booleanInclude deleted instances
List of clusters retrieved successfully
recordscluster[]requiredShow propertiesHide properties
clusteriduuidrequiredA universally unique identifier (UUID) string
organization_iduuidrequiredA universally unique identifier (UUID) string
namestringrequiredThe name of the cluster.
cloud_providercloud_providerrequiredThe cloud provider for the cluster.
customawsgcpstatecluster_staterequiredThe current lifecycle state of the cluster.
UNKOWNREADYDEPLOYEDDEPLOYINGDEPLOY_QUEUEDDEPLOY_ERRORINITIALIZINGINITIALIZEDINITIALIZE_QUEUEDINITIALIZE_ERRORSTOPEDSTOPINGSTOP_QUEUEDSTOP_ERRORRESTARTRESTARTINGRESTART_QUEUEDRESTART_ERRORcreated_atstring<date-time>requiredThe timestamp when the cluster was created.
update_atstring<date-time>requiredThe timestamp when the cluster was last updated.
deleted_atstring<date-time> | nullrequiredThe timestamp when the cluster was deleted updated.
paginationpagination_metarequiredPagination metadata object containing information about the current page, total records, and navigation details for paginated API responses
Show propertiesHide properties
total_recordsintegerrequiredTotal number of records available
current_pageintegerrequiredCurrent page number
total_pagesintegerrequiredTotal number of pages available
next_pageinteger | nullrequiredNext page number, null if no next page exists
prev_pageinteger | nullrequiredPrevious page number, null if no previous page exists
Error
codeinteger<int32>requiredmessagestringrequiredreasonstringOptional stable machine-readable reason for programmatic error handling