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

API Calls to use Devices Troubleshooting tools specific to WAN Assurance

Mist Utilities WAN API is one of 212 APIs that Mist 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.

This API exposes 14 operations across 14 paths, and defines 24 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.

14 operations 14 paths 24 schemas 14 POST

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

response_http403
object
Standard HTTP 403 permission error response
1 property
utils_clear_session_session_ids
array
Session identifiers to clear
utils_release_dhcp
object
Request to release the DHCP lease on a device interface
2 properties 1 required
utils_clear_session
object
To use five tuples to lookup the session to be cleared, all must be provided
3 properties
utils_clear_bgp_type
string
enum: hard, in, out, soft
response_http400
object
Standard HTTP 400 bad request error response
1 property
utils_show_ospf_summary
object
OSPF summary command request for SSR and SRX devices
2 properties
utils_show_session
object
Active session lookup request for device command output
3 properties
utils_show_ospf_database
object
OSPF database command request for SSR and SRX devices
3 properties
utils_clear_arp
object
Request to clear ARP entries on a device
5 properties
utils_clear_bgp
object
Request to clear BGP sessions on a device
4 properties 2 required
websocket_session_with_url
object
Response containing a WebSocket session handle and connection URL
2 properties 2 required
response_http404
object
Standard HTTP 404 not found error response
1 property
ha_cluster_node_enum
string
HA cluster node selector. enum: node0, node1
utils_show_route
object
Route table lookup request for device command output
8 properties
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
utils_show_ospf_interfaces
object
OSPF interfaces command request for SSR and SRX devices
3 properties
utils_service_ping
object
Service ping request for SSR devices
6 properties 2 required
utils_show_route_protocol
string
enum: any, bgp, direct, evpn, ospf, static
utils_show_service_path
object
Service path lookup request for SSR devices
2 properties
utils_show_ospf_neighbors
object
OSPF neighbors command request for SSR and SRX devices
4 properties
ha_cluster_node
object
HA cluster node selector for device operations
1 property
websocket_session
object
Response containing the WebSocket session handle for asynchronous command output
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-utilities-wan-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 Utilities WAN 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.