/2016-07/clusters

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.

KeyDescription
account_idThe account id associated with the cluster.
account_slugThe account slug associated with the cluster.
created_atThe date that the cluster was created.
idThe cluster id.
multitenantWhether or not this cluster is a multitenant (as opposed to an enterprise cluster).
nameThe name of the cluster.
providerThe cloud provider of the cluster (aws, softlayer, gcp, etc).
regionThe region the cluster is in. Please refer to the associated cloud provider documentation for a list of possible regions.
subdomainThe subdomain used by the hosts in this cluster.
typeThe type of the cluster (enterprise, multitenant, etc).
tagsUser-defined tags on the cluster as a string array.
Language
Authentication
Header
Click Try It! to start a request and see the response here!