Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Juniper Mist AI

Juniper Mist AI 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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
Contact
Thomas Munzer
License
MIT
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Orgs 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 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.

tunterm_port_config_upstream_ports
array
List of ports to be used for upstream purpose (to LAN)
mxedges_assign_mxedge_ids
array
claim_codes
array
List of Claim Codes
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
org_mxedge_count_distinct
string
enum: distro, model, mxclusterid, siteid, tuntermversion
org_mxedge_events_count_distinct
string
enum: mxclusterid, mxedgeid, package, type
mxedge_versions
object
2 properties
response_assign_success
object
1 property 1 required
mxedge_tunterm_multicast_mdns
object
2 properties
response_http401
object
1 property
mxedge_vm_params
object
Mist Edge VM parameters
3 properties
get_org_mxedge_upgrade_info_channel
string
enum: alpha, beta, stable
response_count
object
6 properties 6 required
mxedges_unassign
object
1 property 1 required
mxedges_assign
object
2 properties 2 required
mxedge_tunterm_multicast_config
object
2 properties
mxedge_tunterm_dhcpd_config_servers
array
List of DHCP servers; required if type==relay
response_claim_mx_edge
object
2 properties 2 required
mxedge_for_site
string
enum: any, false, true
vlan_id_with_variable
mxedge_tunterm_dhcpd_type
string
enum: relay
search_mxedge
object
10 properties
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
mac_addresses_macs
array
mxedge_tunterm_igmp_snooping_config
object
3 properties
mxedge_tunterm_ip_config
object
IPconfiguration of the Mist Tunnel interface
6 properties 3 required
response_mxedge_search
object
6 properties
mxedge_events
array
mxedge
object
MxEdge
29 properties 2 required
image_import
object
2 properties 1 required
mxedge_tunterm_multicast_ssdp
object
2 properties
mxedge_mgmt_oob_ip_type
string
enum: dhcp, disabled, static
count_result
object
1 property 1 required
mxedge_mgmt
object
6 properties
mac_addresses
object
1 property 1 required
mxedges
array
mxedge_service_action
string
enum: restart, start, stop
mxedge_upgrade_info_items
object
4 properties 2 required
event_severity
string
mxedge_tunterm_monitoring
array
mxedge_tunterm_switch_config_vlan_ids
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
response_mxedge_search_results
array
id
string
Unique ID of the object instance in the Mist Organization
utils_tunterm_bounce_port
object
2 properties 1 required
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 properties 2 required
mxedge_tunterm_dhcpd_config
object
Global and per-VLAN. Property key is the VLAN ID
3 properties
mxedge_upgrade_info
array
mxedge_tunterm_extra_route
object
1 property
mxedge_service_name
string
enum: mxagent, mxdas, mxocproxy, radsecproxy, tunterm
mxedge_event
object
18 properties
utils_tunterm_bounce_port_ports
array
List of ports to bounce
mxedges_unassign_mxedge_ids
array
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.

Source

mist-ai-orgs-mxedges-api-openapi.yml Raw ↑

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
AE Profile APIs.io
Juniper Mist Webhooks API
AE Profile APIs.io
Juniper Mist AI Admins API
AE Profile APIs.io
Juniper Mist AI Admins Login API
AE Profile APIs.io
Juniper Mist AI Admins Login - OAuth2 API
AE Profile APIs.io
Juniper Mist AI Admins Logout API
AE Profile APIs.io
Juniper Mist AI Admins Lookup API
AE Profile APIs.io
Juniper Mist AI Admins Recover Password API
AE Profile APIs.io
Juniper Mist AI Constants Definitions API
AE Profile APIs.io
Juniper Mist AI Constants Events API
AE Profile APIs.io
Juniper Mist AI Constants Models API
AE Profile APIs.io
Juniper Mist AI Installer API
AE Profile APIs.io
#Orgs MxEdges
← Back to J APIs
API Details
ID
mist-ai:mist-ai-orgs-mxedges-api
Base URL
https://api.mist.com/api/v1
Docs
https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started
Provider
Juniper Mist AI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network