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.

application/json

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

200

Successful Operation

application/json

Schema

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.

Example (from schema)

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

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "ADVERTISEMENT_INTERVAL_INVALID_DECIMAL"
      },
      {
        "code": "ADVERTISEMENT_INTERVAL_REQD"
      },
      {
        "code": "ADVERTISEMENT_INTERVAL_LOWER_THAN_ONE_SEC_ERR"
      }
    ]
  }
}

Loading...