/2016-07/clusters/:id

Gets the details of a specific cluster.

This endpoint returns a single cluster associated with the cluster id used in the path parameters. It returns the same information as the /2016-07/clusters endpoint, but for a single cluster. The key/values of cluster objects are detailed below.

Returned JSON

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. Same id as the one used in the path parameters.
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!