Get Clusters List

Description: Retrieve a list of clusters configured by the user, optionally returning the associated nodes for each cluster based on user input.

Security: Requires a valid user with a "Admin" permission

Usage: POST/runtime/api/v1/clusters

Consumes: application/json

Produces: application/json

Request body

Name	Type	Required/Optional	Description
`limit`	int	Optional	Maximum number of clusters to return per request. Default is `10`. (Range: 1-100)
`next_key`	string	Optional	ID from the previous request, empty on the first request

Response body

Name	Type	Description
`total_count`	int	The total number of clusters that match the filter query.
`pagination`	paginationObj	Pagination info for the request
`clusters`	Array[clusterObj]	A list of cluster objects containing details of each cluster.

paginationObj:

Name	Type	Description
`limit`	int	Key-based pagination - number of rows per request
`next_key`	string	Id from the previous request, empty on the first request

clusterObj:

Name	Type	Description
`monitored_at`	string (ISO 8601)	Timestamp when the monitoring of cluster started
`id`	string	Unique identifier for the cluster in the system. (this is the cluster_identifier)
`name`	string	The name of the cluster.
`controller_version`	string	Version of the cluster controller.
`controller_status`	string	Possible options: `running`, `stopped`
`controller_last_updated`	string	Date of last update
`provider`	string	The cloud provider where the cluster is hosted (e.g., aws).
`regions`	Array[string]	List of regions in which the cluster is deployed.
`nodes_count`	int	The total number of nodes in the cluster.
`running_nodes_count`	int	The number of nodes currently running.
`failed_nodes_count`	int	The number of nodes that have failed.
`failed_to_install_nodes_count`	int	The number of nodes that failed to install.
`disabled_nodes_count`	int	The number of nodes that are currently disabled.

Response codes:

Status code	Status code
200	OK
400	Bad request - Required fields are missing
403	Permission denied
404	Not found
500	Internal server error

Request URL :

POST /runtime/api/v1/clusters

Examples

Example request

{
  "limit": "50",
  "last_key": "id123",
}

Example successful response

200 OK
{
   "clusters": [
       {
           "controller_last_updated": "2024-12-31T11:32:10.367653Z",
           "controller_status": "running",
           "controller_version": "0.0.0",
           "disabled_nodes_count": 0,
           "failed_nodes_count": 0,
           "failed_to_install_nodes_count": 0,
           "id": 2,
           "monitored_at": "2024-12-25T12:28:13.438479Z",
           "name": "z0runtime",
           "nodes_count": 4,
           "provider": "kubernetes",
           "regions": [],
           "running_nodes_count": 4
       }
   ],
   "pagination": {
       "limit": 10
   },
   "total_count": 1
}

Example error response:

404 Not Found
{
    "error": "error message"
}