Gets all the clusters accessible to your user.
Enterprise clusters associated with an account can be enumerated with this endpoint. If enterprise clusters exist, it returns an array of objects with information about each. Most importantly, this includes the cluster id which can be used with other endpoints to specify a deployment destination.
Returned JSON
The endpoint returns an array of clusters which contain the following fields.
Key | Description |
|---|---|
account_id | The account id associated with the cluster. |
account_slug | The account slug associated with the cluster. |
created_at | The date that the cluster was created. |
id | The cluster id. |
multitenant | Whether or not this cluster is a multitenant (as opposed to an enterprise cluster). |
name | The name of the cluster. |
provider | The cloud provider of the cluster (aws, softlayer, gcp, etc). |
region | The region the cluster is in. Please refer to the associated cloud provider documentation for a list of possible regions. |
subdomain | The subdomain used by the hosts in this cluster. |
type | The type of the cluster (enterprise, multitenant, etc). |
tags | User-defined tags on the cluster as a string array. |