OrgsInventory

createOrgGatewayHaCluster

POST
/api/v1/orgs/{org_id}/inventory/create_ha_cluster

Create a gateway HA cluster from unassigned gateway inventory nodes and assign the cluster to the specified site.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Request Body

application/json

Request to create an HA cluster from unassigned gateway inventory nodes

disable_auto_config?boolean
Deprecated

This disables the default behavior of a cloud-ready switch/gateway being managed/configured by Mist. Setting this to true means you want to disable the default behavior and do not want the device to be Mist-managed.

managed?boolean
Deprecated

An adopted switch/gateway will not be managed/configured by Mist by default. Setting this parameter to true enables the adopted switch/gateway to be managed/configured by Mist.

mist_configured?boolean

whether the device can be configured by Mist or not. This deprecates managed (for adopted device) and disable_auto_config for claimed device)

nodes?array<>

Gateway nodes to include in the HA cluster; each node must be currently unassigned in inventory

site_id?string

Site where the HA cluster should be created

Formatuuid

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/inventory/create_ha_cluster" \  -H "Content-Type: application/json" \  -d '{    "disable_auto_config": true,    "mist_configured": true,    "nodes": [      {        "mac": "aff827549235"      },      {        "mac": "8396cd006c8c"      }    ],    "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b"  }'
Empty