Cloud Providers /

List clusters

Lists clusters for the authenticated user or team.

Required permission

Account > Cloud > Clusters > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

clusters
[array] required
An array of clusters.

{object}
A cluster object.

id
string required
Identifier for the cluster.
name
string required
The name of the cluster.
description
string
A short description of the cluster.
provider
string
The cloud provider to which this cluster belongs to.
integrationId
string required
ID of the provider integration used by this cluster.
min length
3
max length
39
pattern
^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$
nodePools
[array] required

{object}

nodeType
string required
Machine type to be used by the node pool.
nodeCount
integer required
Number of nodes to the node pool should be provisioned with.
min
0
max
250
autoscaling
{object}
Auto scaling settings to use for the node pool. Requires that the cloud provider supports this feature.

enabled
boolean
min
integer
min
0
max
249
max
integer
min
1
max
250

computeResources
{object}

gpu
{object}

mig
{object}

enabled
boolean
partitions
[array]

string

timeslicing
{object}

enabled
boolean
numSlices
number
min
1

preemptible
boolean
Configures node pool with preemptible / spot instances if enabled.
diskType
string
The disk type to use.
diskSize
integer required
Disk size in GB
min
1
systemPool
boolean
When 'provider' is 'azure', at least one system node pool is required per cluster.
availabilityZones
[array] required
Zones in which the node pool should be provisioned.

string

labels
{object}
Set of label keys and values that can be used to determine scheduling via resource tags.

id
string
ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools

status
{object}

state
{object}

state
string
transitionTime
string

nextUpdateAfter
string

createdAt
string required
The time the cluster was created.
deletionRequested
boolean required
Indicates if provider resource deletion has been requested by the user.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/cloud-providers/clusters

Example response

200 OK

A list of clusters for the authenticated user

JSON

{
  "data": {
    "clusters": [
      {
        "id": "gcp-cluster-1",
        "name": "GCP Cluster 1",
        "description": "The cluster description",
        "provider": "gcp",
        "integrationId": "gcp-integration",
        "nodePools": [
          {
            "nodeType": "n2-standard-8",
            "nodeCount": 3,
            "autoscaling": {
              "enabled": true,
              "min": 0,
              "max": 10
            },
            "computeResources": {
              "gpu": {
                "mig": {
                  "partitions": [
                    null
                  ]
                }
              }
            },
            "preemptible": false,
            "diskSize": 100,
            "availabilityZones": [
              null
            ],
            "id": "6aa96121-0345-43ad-bade-af36d540c222"
          }
        ],
        "createdAt": "2021-01-20T11:19:53.175Z",
        "deletionRequested": false
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}