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

Juniper Mist AI Orgs MxTunnels API

A Mist Tunnel (MxTunnel) is a configuration object that allows for the tunneling of user VLANs from the Access Points (APs) to a central point on the network.It specifies the VLAN IDs that need to be tunneled and assigns the tunnel to a primary or secondary mist edge cluster. The mist tunnel also includes settings for tunnel fail over, auto-preemption, and other parameters related to tunnel termination services.

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

This API exposes 5 operations across 2 paths, and defines 24 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 operations 2 paths 24 schemas 1 DELETE2 GET1 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
License
Resource Areas
1

Authentication & Security 3

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

A Mist Tunnel (MxTunnel) is a configuration object that allows for the tunneling of user VLANs from the Access Points (APs) to a central point on the network. It specifies the VLA…

GET
/api/v1/orgs/{org_id}/mxtunnels
listOrgMxTunnels
listOrgMxTunnels 3 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxtunnels
createOrgMxTunnel
createOrgMxTunnel 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/mxtunnels/{mxtunnel_id}
deleteOrgMxTunnel
deleteOrgMxTunnel 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxtunnels/{mxtunnel_id}
getOrgMxTunnel
getOrgMxTunnel 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/mxtunnels/{mxtunnel_id}
updateOrgMxTunnel
updateOrgMxTunnel 2 params body → 200400401403404429

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are mxtunnel (16 properties), mxtunnel_ipsec (6 properties), auto_preemption (3 properties), mxtunnel_ipsec_extra_route (2 properties). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
auto_preemption
object
Schedule to preempt ap’s which are not connected to preferred peer
3 properties
time_of_day
string
any / HH:MM (24-hour format)
strings
array
day_of_week
string
enum: any, fri, mon, sat, sun, thu, tue, wed
response_http403
object
1 property
mxtunnels
array
mxtunnel_ipsec_extra_route
object
2 properties
site_id
string
mxtunnel_ipsec_extra_routes
array
response_http404
object
1 property
mxtunnel_anchor_mxtunnel_ids
array
List of anchor mxtunnels used for forming edge to edge tunnels
modified_time
number
When the object has been modified for the last time, in epoch
response_http400
object
1 property
mxtunnel_protocol
string
enum: ip, udp
mxtunnel
object
MxTunnel
16 properties
response_http429
object
1 property
mxtunnel_vlan_ids
array
List of vlanids that will be used
mxtunnel_mxcluster_ids
array
List of mxclusters to deploy this tunnel to
mxtunnel_ipsec_dns_servers
arraynull
mxtunnel_ipsec
object
6 properties
response_http401
object
1 property
org_id
string
created_time
number
When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API