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

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items SpokeCluster[]
Array [
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.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "advertisement_interval": 0,
      "id": "string",
      "name": "string",
      "preempt": true,
      "tags": [
        "string"
      ]
    }
  ]
}

Loading...