MxEdges (Mist Edges) at the site level are deployed to tunnel traffic at each site due to network constraints or security concerns.They can be assigned to a specific site and configured to provide tunneling and radius proxy services for the access points (APs) in that site.These Mist Edges allow for the extension of user vlans from the corporate network to the aps, and they support features such as auto preemption for failover, dual tunneling to different mist edge clusters, and anchor tunnels for traffic routing to dmz areas.
Juniper Mist AI Sites MxEdges 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 Sites MxEdges. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
7 operations
across 5 paths,
and defines 58 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.
7 operations5 paths58 schemas1 DELETE4 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Juniper Mist AI Sites MxEdges 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 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Sites MxEdges 7
MxEdges (Mist Edges) at the site level are deployed to tunnel traffic at each site due to network constraints or security concerns. They can be assigned to a specific site and con…
The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are mxedge (29 properties), mxedge_event (18 properties), mxedge_oob_ip_config (11 properties), response_count (6 properties). Each schema is shown below with its type and property counts.
tunterm_port_config_upstream_ports
array
List of ports to be used for upstream purpose (to LAN)
strings
array
mxedge_oob_ip_config_dns
array
IPv4 ignored if type!=static, IPv6 ignored if type6!=static
response_mxedge_events_search
object
6 properties
mxedge_tunterm_igmp_snooping_config_vlan_ids
List of vlans on which tunterm performs IGMP snooping
timestamp
number
Epoch (seconds)
tunterm_port_config
object
Ethernet port configurations
4 properties
mxedge_versions
object
2 properties
mxedge_tunterm_multicast_mdns
object
2 properties
response_http401
object
1 property
response_count
object
6 properties6 required
mxedge_tunterm_multicast_config
object
2 properties
mxedge_tunterm_dhcpd_config_servers
array
List of DHCP servers; required if type==relay
site_mxedge_events_count_distinct
string
enum: mxclusterid, mxedgeid, package, type
vlan_id_with_variable
mxedge_tunterm_dhcpd_type
string
enum: relay
mxedge_oob_ip_config
object
IPconfiguration of the Mist Edge out-ofband management interface
11 properties
mxedge_tunterm_igmp_snooping_querier
object
5 properties
created_time
number
When the object has been created, in epoch
mxedge_tunterm_igmp_snooping_config
object
3 properties
mxedge_tunterm_ip_config
object
IPconfiguration of the Mist Tunnel interface
6 properties3 required
mxedge_events
array
mxedge
object
MxEdge
29 properties2 required
mxedge_tunterm_multicast_ssdp
object
2 properties
mxedge_mgmt_oob_ip_type
string
enum: dhcp, disabled, static
count_result
object
1 property1 required
mxedge_mgmt
object
6 properties
mxedges
array
event_severity
string
mxedge_tunterm_switch_config_vlan_ids
array
mxedge_tunterm_monitoring
array
mxedge_tunterm_switch_configs
object
If custom vlan settings are desired
1 property
response_http429
object
1 property
mxedge_mgmt_oob_ip_type6
string
enum: autoconf, dhcp, disabled, static
mxedge_event_sys_info
object
2 properties
tunterm_monitoring_protocol
string
enum: arp, ping, tcp
tunterm_port_config_downstream_ports
array
List of ports to be used for downstream (to AP) purpose
org_id
string
tunterm_monitoring_item
object
5 properties
id
string
Unique ID of the object instance in the Mist Organization
response_http403
object
1 property
count_results
array
ip_type
string
enum: dhcp, static
proxy
object
Proxy Configuration to talk to Mist
2 properties
site_id
string
response_http404
object
1 property
tunterm_monitoring
array
tunterm_port_config_upstream_port_vlan_id
Native VLAN id for upstream ports
mxedge_tunterm_dhcpd_config_type
string
enum: relay
mxedge_services
array
List of services to run, tunterm only for now
response_http400
object
1 property
mxedge_tunterm_other_ip_config
object
2 properties2 required
mxedge_tunterm_dhcpd_config
object
Global and per-VLAN. Property key is the VLAN ID
3 properties
mxedge_tunterm_extra_route
object
1 property
mxedge_event
object
18 properties
modified_time
number
When the object has been modified for the last time, in epoch
mxedge_tunterm_dhcpd_config_property
object
3 properties
mxedge_tunterm_switch_config
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
