Create Spoke Cluster (v2.0)
Create cluster to determine which data center communicates with which branch devices.
Path Parameters
- tenant_id string required
The tenant ID.
- site_id string required
ID of the site. More details on the site can be retrieved by querying the sites API.
- application/json
Request Body
Details of the spokecluster to be created
- advertisement_interval double required
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 string required
Name of the cluster.
- preempt boolean required
Indicates if preemption is required or not.
- tags string[]
Displays the details about the tags or labels applied to the clusters.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- advertisement_interval double required
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 string required
Name of the cluster.
- preempt boolean required
Indicates if preemption is required or not.
- tags string[]
Displays the details about the tags or labels applied to the clusters.
{
"advertisement_interval": 0,
"id": "string",
"name": "string",
"preempt": true,
"tags": [
"string"
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON_INPUT"
},
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "SPOKECLUSTER_CONFIG_INVALID_SITE"
},
{
"code": "SPOKECLUSTER_CONFIG_EXCEEDS_LIMIT"
},
{
"code": "ADVERTISEMENT_INTERVAL_INVALID_DECIMAL"
},
{
"code": "ADVERTISEMENT_INTERVAL_REQD"
}
]
}
}