How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mist Sites MxEdges API

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.

Mist Sites MxEdges API is one of 212 APIs that Mist 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.

This API exposes 7 operations across 5 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 2606.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 operations 5 paths 58 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Mist Sites MxEdges API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

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…

GET
/api/v1/sites/{site_id}/mxedges
listSiteMxEdges
listSiteMxEdges 3 params → 200400401403404429
GET
/api/v1/sites/{site_id}/mxedges/events/count
countSiteMxEdgeEvents
countSiteMxEdgeEvents 10 params → 200400401403404429
GET
/api/v1/sites/{site_id}/mxedges/events/search
searchSiteMistEdgeEvents
searchSiteMistEdgeEvents 12 params → 200400401403404429
DELETE
/api/v1/sites/{site_id}/mxedges/{mxedge_id}
deleteSiteMxEdge
deleteSiteMxEdge 2 params → 200400401403404429
GET
/api/v1/sites/{site_id}/mxedges/{mxedge_id}
getSiteMxEdge
getSiteMxEdge 2 params → 200400401403404429
PUT
/api/v1/sites/{site_id}/mxedges/{mxedge_id}
updateSiteMxEdge
updateSiteMxEdge 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/mxedges/{mxedge_id}/support
uploadSiteMxEdgeSupportFiles
uploadSiteMxEdgeSupportFiles 2 params → 200400401403404429

Schemas 58

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.

site_mxedge_events_count_distinct
string
enum: mxclusterid, mxedgeid, package, type
mxedge_tunterm_multicast_mdns
object
mDNS forwarding settings for tunnel termination
2 properties
mxedge_tunterm_igmp_snooping_querier
object
IGMP querier settings for tunnel termination
5 properties
org_id
string
Unique identifier of a Mist organization
strings
array
Unique string values returned or accepted by this schema
mxedge_mgmt_oob_ip_type6
string
enum: autoconf, dhcp, disabled, static
count_results
array
List of count result rows
response_mxedge_events_search
object
Search response for Mist Edge event records
6 properties
mxedge_tunterm_other_ip_config
object
Additional IP configuration for a Mist Tunnel VLAN interface
2 properties 2 required
tunterm_monitoring_protocol
string
enum: arp, ping, tcp
mxedge_tunterm_switch_config
object
Switch VLAN settings for one tunnel termination port
2 properties
mxedge_tunterm_extra_route
object
Extra route for Mist Tunnel traffic on a Mist Edge
1 property
mxedge_tunterm_igmp_snooping_config_vlan_ids
List of VLAN IDs where tunnel termination performs IGMP snooping
mxedge_oob_ip_config_dns
array
IPv4 ignored if type!=static, IPv6 ignored if type6!=static
tunterm_port_config_upstream_port_vlan_id
Native VLAN ID for upstream ports
mxedge_tunterm_dhcpd_config_property
object
Per-VLAN DHCP relay settings for a Mist Tunneled VLAN
3 properties
response_http403
object
Standard HTTP 403 permission error response
1 property
mxedge_tunterm_monitoring
array
Tunnel termination monitoring checks for a Mist Edge
proxy
object
Proxy Configuration to talk to Mist
2 properties
mxedge_mgmt
object
Management settings for a Mist Edge appliance
6 properties
tunterm_port_config
object
Ethernet port configuration for tunnel termination interfaces
4 properties
mxedge_tunterm_igmp_snooping_config
object
IGMP snooping settings for Mist Tunnel VLANs
3 properties
mxedge_tunterm_switch_configs
object
Custom VLAN settings for tunnel termination switch ports, if desired; property key is the port identifier
1 property
mxedge_tunterm_ip_config
object
IP configuration for the Mist Tunnel interface
6 properties 3 required
mxedge_tunterm_dhcpd_config
object
Global and per-VLAN DHCP relay settings for Mist Tunneled VLANs; property key is the VLAN ID
3 properties
tunterm_port_config_downstream_ports
array
List of ports to be used for downstream (to AP) purpose
mxedge_mgmt_oob_ip_type
string
enum: dhcp, disabled, static
mxedge_oob_ip_config
object
IP configuration for the Mist Edge out-of-band management interface
11 properties
event_severity
string
Severity level for an event. enum: normal, critical, high, warning
ip_type
string
IP address assignment mode, either DHCP or static. enum: dhcp, static
mxedge_tunterm_multicast_ssdp
object
SSDP forwarding settings for tunnel termination
2 properties
created_time
number
When the object has been created, in epoch
mxedge_tunterm_dhcpd_config_servers
array
List of DHCP servers; required if type==relay
response_count
object
Distinct count response for time-bounded search results
6 properties 6 required
mxedge_event_sys_info
object
System resource details for a Mist Edge event
2 properties
mxedges
array
List of Mist Edge appliances
vlan_id_with_variable
VLAN ID, either numeric or expressed as a template variable string
tunterm_port_config_upstream_ports
array
List of ports to be used for upstream purpose (to LAN)
timestamp
number
Epoch timestamp, in seconds
mxedge_tunterm_dhcpd_type
string
DHCP handling mode for the global tunnel termination config. enum: relay
mxedge_events
array
Mist Edge event records
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
id
string
Unique ID of the object instance in the Mist Organization
mxedge_versions
object
Read-only Mist Edge service versions
2 properties
mxedge_tunterm_dhcpd_config_type
string
DHCP handling mode for this tunneled VLAN. enum: relay
mxedge_services
array
List of services to run, tunterm only for now
response_http400
object
Standard HTTP 400 bad request error response
1 property
mxedge_event
object
Event reported for a Mist Edge appliance or service
18 properties
mxedge_tunterm_multicast_config
object
Multicast forwarding settings for tunnel termination
2 properties
modified_time
number
When the object has been modified for the last time, in epoch
count_result
object
Count result row with the matching distinct field values
1 property 1 required
response_http404
object
Standard HTTP 404 not found error response
1 property
tunterm_monitoring
array
Tunnel termination monitoring checks
site_id
string
Unique identifier of a Mist site
mxedge_tunterm_switch_config_vlan_ids
array
Tagged VLAN IDs allowed on a tunnel termination switch port
mxedge
object
Mist Edge appliance configuration and registration state
29 properties 2 required
tunterm_monitoring_item
object
Monitoring check for tunnel termination reachability
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-sites-mxedges-api-openapi.yml Raw ↑

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
Where this information came from

This is an independent, third-party profile of Mist Sites MxEdges API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.