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 Utilities WAN API

API Calls to use Devices Troubleshooting tools specific to WAN Assurance

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 14 operations across 14 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.

14 operations 14 paths 24 schemas 14 POST

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 Utilities WAN 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 14

Across 14 paths, the API surfaces 14 operations — 14 POST. Each is listed below with its method, path, parameters, and response codes.

Utilities WAN 14

API Calls to use Devices Troubleshooting tools specific to WAN Assurance

POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_arp
clearSiteSsrArpCache
clearSiteSsrArpCache 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_bgp
clearSiteBgpRoutes
clearSiteSsrBgpRoutes 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_session
clearSiteDeviceSession
clearSiteDeviceSession 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/release_dhcp
releaseSiteSsrDhcpLease
releaseSiteSsrDhcpLease 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/resolve_dns
testSiteSsrDnsResolution
testSiteSsrDnsResolution 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/run_top
runSiteSrxTopCommand
runSiteSrxTopCommand 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/service_ping
servicePingFromSsr
servicePingFromSsr 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_ospf_database
showSiteGatewayOspfDatabase
showSiteGatewayOspfDatabase 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_ospf_interfaces
showSiteGatewayOspfInterfaces
showSiteGatewayOspfInterfaces 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_ospf_neighbors
showSiteGatewayOspfNeighbors
showSiteGatewayOspfNeighbors 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_ospf_summary
showSiteGatewayOspfSummary
showSiteGatewayOspfSummary 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_route
showSiteSsrAndSrxRoutes
showSiteSsrAndSrxRoutes 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_service_path
showSiteSsrServicePath
showSiteSsrServicePath 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_session
showSiteSsrAndSrxSessions
showSiteSsrAndSrxSessions 2 params body → 200400401403404429

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are utils_show_route (8 properties), utils_service_ping (6 properties), utils_clear_arp (5 properties), utils_show_ospf_neighbors (4 properties). Each schema is shown below with its type and property counts.

utils_show_route_protocol
string
enum: any, bgp, direct, evpn, ospf, static
utils_show_session
object
3 properties
response_http403
object
1 property
websocket_session_with_url
object
2 properties 2 required
utils_show_route
object
8 properties
utils_show_ospf_database
object
3 properties
utils_show_ospf_summary
object
2 properties
utils_clear_bgp_type
string
enum: hard, in, out, soft
utils_show_ospf_interfaces
object
3 properties
utils_service_ping
object
6 properties 2 required
response_http404
object
1 property
utils_clear_session_session_ids
array
List of id of the sessions to be cleared
utils_clear_arp
object
5 properties
utils_clear_bgp
object
4 properties 2 required
response_http400
object
1 property
response_http429
object
1 property
utils_show_ospf_neighbors
object
4 properties
websocket_session
object
1 property 1 required
utils_clear_session
object
To use five tuples to lookup the session to be cleared, all must be provided
3 properties
ha_cluster_node_enum
string
only for HA. enum: node0, node1
utils_release_dhcp
object
2 properties 1 required
utils_show_service_path
object
The exact service name for which to display the service path
2 properties
response_http401
object
1 property
ha_cluster_node
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-utilities-wan-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
#Utilities WAN
← Back to J APIs
API Details
ID
mist-ai:mist-ai-utilities-wan-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