Delete Hub Cluster (v4.0)

Delete a hub cluster.

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.

• hub_cluster_id string required

  ID of the hub cluster.

Responses

• 200
• 400

---

Successful operation

application/json

• Schema
• Example (from schema)

---

Schema

• default_cluster boolean

  List the details of the default cluster.

• description

  Description of the default cluster.

• elements HubClusterElement[]

  Details of the elements in the cluster.

  Array [

  hubClusterElementNumber string

  Possible values: [FIRST, SECOND, THIRD]

  HubClusterElementNumber: JsonIgnore(value = true)

  hub_element_id string

  Hub Element Id

  locked boolean

  Locked

  ]
• id string

  The ID of the cluster.

• name string required

  The name of the cluster.

• peer_sites string[] required

  The sites associated with the data center cluster.

• site_count_alarm_threshold integer

  The count threshold of the alarms for the sites.

• tags string[]

  A information field that can be added to identify the hub cluster.

{
  "default_cluster": true,
  "elements": [
    {
      "hubClusterElementNumber": "FIRST",
      "hub_element_id": "string",
      "locked": true
    }
  ],
  "id": "string",
  "name": "string",
  "peer_sites": [
    "string"
  ],
  "site_count_alarm_threshold": 0,
  "tags": [
    "string"
  ]
}

Bad request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• _error ErrorResponse[]

  Array [

  code string

  message string

  ]

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

{
  "value": {
    "_error": [
      {
        "code": "HUB_CLUSTER_NOT_FOUND"
      },
      {
        "code": "HUB_CLUSTER_HAS_ELEMENTS"
      }
    ]
  }
}

Loading...