Skip to main content

Get Spoke Clusters (v2.0)



List all the spoke clusters for a particular site.


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.


Successful Operation

    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.


    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.

  • ]