A Mist Edge Cluster (MxCluster) is a group of Juniper Mist Edge devices that are configured to work together in order to provide high availability and load balancing for the tunneling of traffic from access points (APs). The cluster can consist of a single edge device or multiple edge devices.
Juniper Mist AI Orgs MxClusters API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Orgs MxClusters. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
5 operations
across 2 paths,
and defines 50 schemas.
It is described by OpenAPI 3.1.0, at version 2604.1.1.
Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.
5 operations2 paths50 schemas1 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Juniper Mist AI Orgs MxClusters API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Orgs MxClusters 5
A Mist Edge Cluster (MxCluster) is a group of Juniper Mist Edge devices that are configured to work together in order to provide high availability and load balancing for the tunne…
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are mxcluster (21 properties), mxcluster_radsec_auth_server (12 properties), mxcluster_radsec (8 properties), mxedge_das_coa_server (6 properties). Each schema is shown below with its type and property counts.
mxcluster_tunterm_hosts_order
array
List of index of tuntermhosts
id
string
Unique ID of the object instance in the Mist Organization
tunterm_dhcpd_type
string
enum: relay
strings
array
mxcluster_rad_auth_server_keywrap_format
stringnull
if used for Mist APs. enum: ascii, hex
mxedge_mgmt_oob_ip_type
string
enum: dhcp, disabled, static
mxedge_das_coa_server
object
6 properties
mxcluster_radsec_auth_server_ssids
array
List of ssids that will use this server if matchssid is true and match is found
response_http403
object
1 property
mxcluster_radsec_acct_servers
array
List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
mxcluster
object
MxCluster
21 properties
mxcluster_nac
object
5 properties
mxcluster_radsec
object
MxEdge RadSec Configuration
8 properties
mxcluster_tunterm_ap_subnets
array
List of subnets where we allow AP to establish Mist Tunnels from
mxedge_mgmt
object
6 properties
mxedge_das_coa_servers
array
Dynamic authorization clients configured to send CoA|DM to mist edges on port 3799
tunterm_dhcpd_config
object
DHCP server/relay configuration of Mist Tunneled VLANs. Property key is the VLAN ID
3 properties
proxy
object
Proxy Configuration to talk to Mist
2 properties
mxclusters
array
site_id
string
mxcluster_nac_client_ip
object
4 properties
response_http404
object
1 property
mxcluster_tunterm_hosts
array
Hostnames or IPs where a Mist Tunnel will use as the Peer (i.e. they are reachable from AP)
tunterm_monitoring
array
mxcluster_nac_client_vendor
string
convention to be followed is : " - ", could be an os/platform/model/company. For ex: for cisco vendor, there could variants wrt os (such as ios, nxos etc), pla…
mxcluster_radsec_auth_servers
array
List of RADIUS authentication servers, order matters where the first one is treated as primary
mxcluster_radsec_nas_ip_source
string
SSpecify NAS-IP-ADDRESS, NAS-IPv6-ADDRESS to use with authservers. enum: any, oob, oob6, tunnel, tunnel6
response_http400
object
1 property
mxcluster_radsec_auth_server
object
12 properties
mxcluster_tunterm_hosts_selection
string
Ordering of tuntermhosts for mxedge within the same mxcluster. enum: shuffle: the ordering of tuntermhosts is randomized by the device''s MAC shuffle-by-site:…
mxcluster_radsec_src_ip_source
string
Specify IP address to connect to authservers and acctservers. enum: any, oob, oob6, tunnel, tunnel6
response_http429
object
1 property
mxcluster_radsec_server_selection
string
When ordered, Mist Edge will prefer and go back to the first radius server if possible. enum: ordered, unordered
mxedge_mgmt_oob_ip_type6
string
enum: autoconf, dhcp, disabled, static
mxcluster_tunterm_extra_routes
object
Extra routes for Mist Tunneled VLANs. Property key is a CIDR
mxcluster_radsec_tls
object
1 property
mxcluster_radsec_proxy_hosts
array
Hostnames or IPs for Mist AP to use as the TLS Server (i.e. they are reachable from AP) in addition to tuntermhosts
mxedge_das
object
Configure cloud-assisted dynamic authorization service on this cluster of mist edges
2 properties
mxcluster_radsec_acct_server
object
4 properties
mxcluster_tunterm_monitoring
array
mxcluster_radsec_acct_server_ssids
array
List of ssids that will use this server if matchssid is true and match is found
tunterm_monitoring_protocol
string
enum: arp, ping, tcp
response_http401
object
1 property
mxcluster_tunterm_extra_route
object
1 property
org_id
string
tunterm_dhcpd_config_property
object
3 properties
mxcluster_nac_client_ips
object
modified_time
number
When the object has been modified for the last time, in epoch
created_time
number
When the object has been created, in epoch
tunterm_monitoring_item
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
