- 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 |
|---|---|
| The response format. The default response format is Values: |
Example usage
Below is a sample request URL for the clusters resource:
https://organization.example.com/<context>/admin/clusters?f=jsonJSON Response syntax
{
"clusters": [
<cluster1>,
<cluster2>,
...
]
}JSON Response example
{
"clusters": [
{
"clusterName": "DevCluster",
"clusterProtocol": {
"type": "TCP",
"tcpClusterPort": 4014
},
"machineNames": [
"MACHINE1.EXAMPLE.COM",
"MACHINE2.EXAMPLE.COM"
]
},
{
"clusterName": "ProdCluster",
"clusterProtocol": {
"type": "TCP",
"tcpClusterPort": 5014
},
"machineNames": [
"MACHINE3.EXAMPLE.COM",
"MACHINE4.EXAMPLE.COM"
]
}
]
}