Clusters

URL:: https://<site-url>/clusters
Methods:: GET
Version Introduced:: 10.1

Description

This resource returns a list of all the clusters created within your site. The Create Cluster operation lets you define a new cluster configuration.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

Example usage

Below is a sample request URL for the clusters resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/admin/clusters?f=json

JSON Response syntax

Use dark colors for code blocksCopy
{
  "clusters": [
    <cluster1>,
    <cluster2>,
    ...
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "clusters": [
    {
      "clusterName": "DevCluster",
      "clusterProtocol": {
        "type": "TCP",
        "tcpClusterPort": 4014
      },
      "machineNames": [
        "MACHINE1.DOMAIN.COM",
        "MACHINE2.DOMAIN.COM"
      ]
    },
    {
      "clusterName": "ProdCluster",
      "clusterProtocol": {
        "type": "TCP",
        "tcpClusterPort": 5014
      },
      "machineNames": [
        "MACHINE3.DOMAIN.COM",
        "MACHINE4.DOMAIN.COM"
      ]
    }
  ]
}