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 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.

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

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

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

response_http403
object
Standard HTTP 403 permission error response
1 property
org_id
string
Unique identifier of a Mist organization
response_http400
object
Standard HTTP 400 bad request error response
1 property
vpn_path_traffic_shaping
object
Traffic shaping settings for a VPN path
3 properties
vpns
array
VPN records returned by a list response
vpn_path_selection_strategy
string
enum: disabled, simple, manual
vpn_mode
string
VPN topology mode for this configuration. enum: hubspoke, mesh
modified_time
number
When the object has been modified for the last time, in epoch
vpn
object
Organization VPN overlay configuration
8 properties 2 required
vpn_path_selection
object
Only if type==hubspoke; path selection behavior for VPN paths
1 property
vpn_paths
object
For type==hubspoke, Property key is the VPN name. For type==mesh, Property key is the Interface name
response_http404
object
Standard HTTP 404 not found error response
1 property
response_http401
object
Standard HTTP 401 authentication error response
1 property
vpn_path_bfd_profile
string
BFD profile used for this VPN path. enum: broadband, lte
response_http429
object
Standard HTTP 429 rate limit error response
1 property
vpn_path_peer_paths
object
If type==mesh, property key is the peer interface name
id
string
Unique ID of the object instance in the Mist Organization
created_time
number
When the object has been created, in epoch
vpn_path_traffic_shaping_class_percentage
array
percentages for different class of traffic: high / medium / low / best-effort adding up to 100
vpn_path
object
VPN path settings used by an organization VPN
6 properties
vpn_path_peer_paths_peer
object
Peer path preference settings for mesh VPN routing
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-orgs-vpns-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 VPNs 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.