Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsMxClusters

createOrgMxEdgeCluster

POST
/api/v1/orgs/{org_id}/mxclusters

Create a Mist Edge cluster with tunnel termination, RadSec, NAC, and management settings.

Note: It is not recommended to combine multiple roles (tunnel termination, RadSec, NAC) on the same Mist Edge cluster

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 Body

Mist Edge cluster that groups one or more Mist Edge devices for tunneling, RadSec, and related edge services

mist_das?

Dynamic authorization service settings for the cluster

mist_nac?

NAC settings for the Mist Edge cluster

mist_nacedge?

NAC Edge survivability settings for the cluster; requires mist_nac to be enabled

mxedge_mgmt?

Out-of-band management settings for Mist Edges in the cluster

name?string

Display name of the Mist Edge cluster

proxy?

Network proxy settings used by Mist Edges in the cluster to communicate with the Mist Cloud

radsec?

TLS RADIUS proxy settings for the Mist Edge cluster

radsec_tls?

TLS keypair settings for RadSec on the Mist Edge cluster

tunterm_ap_subnets?array<string>

AP source subnets allowed to establish Mist tunnels

tunterm_dhcpd_config?

DHCP relay or server settings for tunneled VLANs

tunterm_extra_routes?

Extra routes for Mist Tunnel VLAN traffic

tunterm_hosts?array<string>

Hostnames or IP addresses used as Mist Tunnel peers

tunterm_hosts_order?array<integer>

Explicit host ordering indexes used when ordered selection is configured

tunterm_hosts_selection?mxcluster_tunterm_hosts_selection

Selection strategy for ordering tunnel termination hosts. enum: ordered, shuffle, shuffle-by-site.

Default"shuffle"

Value in

  • "ordered"
  • "shuffle"
  • "shuffle-by-site"
tunterm_monitoring?array<array<>>

Monitoring checks for tunnel termination reachability. Only for Org Mist Edges; use tunterm_monitoring in the site_setting for site-scoped Mist Edges

tunterm_monitoring_disabled?boolean

Whether tunnel termination monitoring is disabled for the cluster

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxclusters" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "radsec": {      "auth_servers": [        {          "host": "string",          "port": 0        }      ],      "enabled": true    },    "tunterm_ap_subnets": [      "string"    ],    "tunterm_hosts": [      "string"    ]  }'
{  "created_time": 0,  "for_site": true,  "id": "468f6eca-6276-4993-bfeb-53cbbbba6f68",  "modified_time": 0,  "name": "string",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "radsec": {    "acct_servers": [      {        "host": "string",        "port": 1813,        "secret": "string"      }    ],    "auth_servers": [      {        "host": "string",        "port": 1812,        "secret": "string"      }    ],    "enabled": true,    "server_selection": "ordered"  },  "radsec_tls": {    "keypair": "string"  },  "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",  "tunterm_ap_subnets": [    "string"  ],  "tunterm_dhcpd_config": {    "enabled": false,    "property1": {      "enabled": false,      "servers": [        "string"      ],      "type": "relay"    },    "property2": {      "enabled": false,      "servers": [        "string"      ],      "type": "relay"    },    "servers": [      "string"    ],    "type": "relay"  },  "tunterm_extra_routes": {    "property1": {      "via": "string"    },    "property2": {      "via": "string"    }  },  "tunterm_hosts": [    "string"  ]}

listOrgMxEdgeClusters GET

List Mist Edge clusters in the organization, which group one or more Mist Edge devices for tunneling, RadSec, and related edge services.

getOrgMxEdgeCluster GET

Retrieve configuration details for a specific Mist Edge cluster, including tunneling, RadSec, NAC, and management settings.