Get Spoke Clusters (v2.0)
GET/v2.0/api/tenants/:tenant_id/sites/:site_id/spokeclusters
List all the spoke clusters for a particular site.
Request
Path Parameters
tenant_id stringrequired
The tenant ID.
site_id stringrequired
ID of the site. More details on the site can be retrieved by querying the sites API.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
count int32
The number of responses.
id string
The ID of the response.
tenant_id string
The ID of the tenant.
items SpokeCluster[]
advertisement_interval doublerequired
Lists the intervals in which the active device advertises its status to the backup.
description
The cluster description.
id string
The ID of the site.
name stringrequired
Name of the cluster.
preempt booleanrequired
Indicates if preemption is required or not.
tags string[]
Displays the details about the tags or labels applied to the clusters.
{
"count": 0,
"id": "string",
"tenant_id": "string",
"items": [
{
"advertisement_interval": 0,
"id": "string",
"name": "string",
"preempt": true,
"tags": [
"string"
]
}
]
}
Loading...