get https://api.compose.io/2016-07/clusters/
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
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. Same id as the one used in the path parameters. |
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. |