Skip to main content

Update Spoke Cluster (v2.0)

PUT 

/v2.0/api/tenants/:tenant_id/sites/:site_id/spokeclusters/:spoke_cluster_id

Details of the spoke cluster that needs to be modified.

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.

    spoke_cluster_id stringrequired

    ID of the spoke cluster.

Body

Details of the spokecluster to be modified

    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.

Responses

Successful Operation

Schema
    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.

Loading...