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 Orgs MxEdges API

A Mist Edge (MxEdge) is a physical or virtual appliance that is deployed in a network to provide centralized data path for user traffic or as a RADIUS Proxy, which was traditionally performed by legacy wireless controllers. It keeps all the control and management functions in the Mist Cloud, offering a microservices architecture to the campus.

Mist Orgs 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 Orgs MxEdges. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 22 operations across 18 paths, and defines 81 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.

22 operations 18 paths 81 schemas 2 DELETE8 GET11 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 Orgs 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 22

Across 18 paths, the API surfaces 22 operations — 2 DELETE, 8 GET, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orgs MxEdges 22

A Mist Edge (MxEdge) is a physical or virtual appliance that is deployed in a network to provide centralized data path for user traffic or as a RADIUS Proxy, which was traditional…

GET
/api/v1/orgs/{org_id}/mxedges
listOrgMxEdges
listOrgMxEdges 4 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges
createOrgMxEdge
createOrgMxEdge 1 param body → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/assign
assignOrgMxEdgeToSite
assignOrgMxEdgeToSite 1 param body → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/claim
claimOrgMxEdge
claimOrgMxEdge 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/count
countOrgMxEdges
countOrgMxEdges 14 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/events/count
countOrgSiteMxEdgeEvents
countOrgSiteMxEdgeEvents 10 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/events/search
searchOrgMistEdgeEvents
searchOrgMistEdgeEvents 12 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/search
searchOrgMxEdges
searchOrgMxEdges 15 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/unassign
unassignOrgMxEdgeFromSite
unassignOrgMxEdgeFromSite 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/versions
getOrgMxEdgeUpgradeInfo
getOrgMxEdgeUpgradeInfo 3 params → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}
deleteOrgMxEdge
deleteOrgMxEdge 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}
getOrgMxEdge
getOrgMxEdge 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}
updateOrgMxEdge
updateOrgMxEdge 2 params body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/image/{image_number}
deleteOrgMxEdgeImage
deleteOrgMxEdgeImage 3 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/image/{image_number}
addOrgMxEdgeImage
addOrgMxEdgeImage 3 params body → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/restart
restartOrgMxEdge
restartOrgMxEdge 2 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/tunterm/bounce_port
bounceOrgMxEdgeDataPorts
bounceOrgMxEdgeDataPorts 2 params body → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/tunterm/disconnect_aps
disconnectOrgMxEdgeTuntermAps
disconnectOrgMxEdgeTuntermAps 2 params body → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/{name}/{action}
controlOrgMxEdgeServices
controlOrgMxEdgeServices 4 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/support
uploadOrgMxEdgeSupportFiles
uploadOrgMxEdgeSupportFiles 2 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/unregister
unregisterOrgMxEdge
unregisterOrgMxEdge 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/vm_params
getOrgMxEdgeVmParams
getOrgMxEdgeVmParams 2 params → 200400401403404429

Schemas 81

The contract defines 81 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), search_mxedge (10 properties). Each schema is shown below with its type and property counts.

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
mxedge_service_name
string
Mist Edge service name. enum: mxagent, mxdas, mxnacedge, mxocproxy, radsecproxy, tunterm
org_id
string
Unique identifier of a Mist organization
mxedge_service_action
string
enum: restart, start, stop
mxedges_unassign_mxedge_ids
array
Mist Edge identifiers to unassign from their site
claim_codes
array
List of Claim Codes
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
mxedge_for_site
string
enum: any, false, true
response_mxedge_events_search
object
Search response for Mist Edge event records
6 properties
utils_tunterm_bounce_port
object
Request to bounce Mist Edge TunTerm data ports
2 properties 1 required
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
response_mxedge_search_results
array
Mist Edge search records returned by a search response
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_upgrade_info_items
object
Available upgrade version for a Mist Edge package
4 properties 2 required
org_mxedge_count_distinct
string
enum: distro, model, mxclusterid, siteid, tuntermversion
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
org_mxedge_events_count_distinct
string
enum: mxclusterid, mxedgeid, package, type
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
mac_addresses_macs
array
Unique MAC addresses included in a request
mxedge_tunterm_igmp_snooping_config
object
IGMP snooping settings for Mist Tunnel VLANs
3 properties
response_assign_success
object
Assignment operation success response
1 property 1 required
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
mxedges_assign
object
Request to assign Mist Edges to a site
2 properties 2 required
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
get_org_mxedge_upgrade_info_channel
string
enum: alpha, beta, stable
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
mxedges_assign_mxedge_ids
array
Mist Edge identifiers to assign to a site
mxedge_tunterm_dhcpd_config_servers
array
List of DHCP servers; required if type==relay
response_mxedge_search
object
Search response for Mist Edge records
6 properties
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
response_claim_mx_edge
object
Mist Edge claim response
2 properties 2 required
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_vm_params
object
Mist Edge VM parameters
3 properties
mxedges_unassign
object
Request to unassign Mist Edges from their site
1 property 1 required
mac_addresses
object
Request containing one or more MAC addresses
1 property 1 required
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
search_mxedge
object
Mist Edge record returned by search APIs
10 properties
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
image_import
object
Multipart image upload payload
2 properties 1 required
mxedge
object
Mist Edge appliance configuration and registration state
29 properties 2 required
utils_tunterm_bounce_port_ports
array
TunTerm data port identifiers to bounce
mxedge_upgrade_info
array
Available Mist Edge upgrade versions by package
tunterm_monitoring_item
object
Monitoring check for tunnel termination reachability
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-orgs-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 Orgs 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.