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 VPNs API

VPNs endpoints are used to create the WAN Assurance Overlay configuration between a Hub and oneor multiple WAN Edge Gateways.When configuring the Hub and Spokes from the Mist UI, the UI is automatically creating or updatingthe VPNs objects based on the configuration. When the configuration is directly done with the APIs, the VPN object must be manually managed.

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

This API exposes 5 operations across 2 paths, and defines 21 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 21 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 VPNs 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 VPNs 5

VPNs endpoints are used to create the WAN Assurance Overlay configuration between a Hub and one or multiple WAN Edge Gateways. When configuring the Hub and Spokes from the Mist UI…

GET
/api/v1/orgs/{org_id}/vpns
listOrgVpns
listOrgVpns 3 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/vpns
createOrgVpn
createOrgVpn 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/vpns/{vpn_id}
deleteOrgVpn
deleteOrgVpn 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/vpns/{vpn_id}
getOrgVpn
getOrgVpn 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/vpns/{vpn_id}
updateOrgVpn
updateOrgVpn 2 params body → 200400401403404429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are vpn (8 properties), vpn_path (6 properties), vpn_path_traffic_shaping (3 properties), response_http403 (1 property). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
vpns
array
vpn_mode
string
enum: hubspoke, mesh
vpn_paths
object
For type==hubspoke, Property key is the VPN name. For type==mesh, Property key is the Interface name
vpn_path_peer_paths
object
If type==mesh, Property key is the Peer Interface name
response_http403
object
1 property
vpn_path_peer_paths_peer
object
Preference indicates which outgoing wan should be preferred
1 property
vpn
object
8 properties 2 required
response_http404
object
1 property
modified_time
number
When the object has been modified for the last time, in epoch
response_http400
object
1 property
vpn_path_selection_strategy
string
enum: disabled, simple, manual
response_http429
object
1 property
vpn_path_traffic_shaping
object
3 properties
vpn_path_bfd_profile
string
enum: broadband, lte
vpn_path
object
6 properties
vpn_path_selection
object
Only if type==hubspoke
1 property
response_http401
object
1 property
org_id
string
vpn_path_traffic_shaping_class_percentage
array
percentages for different class of traffic: high / medium / low / best-effort adding up to 100
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-vpns-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