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

Juniper Networks Utilities WAN API

API Calls to use Devices Troubleshooting tools specific to WAN Assurance

Juniper Networks Utilities WAN API is one of 263 APIs that Juniper Networks 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, an API reference, API documentation, a getting-started guide, and rate-limit docs.

This API exposes 14 operations across 14 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2607.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 34 schemas 14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2607.1.1
Base URL
netconf://[device-ip]:830
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Juniper Networks 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]($e/Admins%20Login/login) request, Mist returns a csrftoken cookie.…

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
clearSiteSsrBgpRoutes
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 34

The contract defines 34 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_clear_bgp (4 properties). Each schema is shown below with its type and property counts.

utils_show_service_path
object
Service path lookup request for SSR devices
2 properties
ha_cluster_node_enum16
string
HA cluster node on which to show OSPF neighbors. enum: node0, node1.
ha_cluster_node_enum14
string
HA cluster node on which to show the OSPF database. enum: node0, node1.
ha_cluster_node1
object
HA cluster node on which to show routes
1 property
ha_cluster_node_enum18
string
HA cluster node on which to show the service path. enum: node0, node1.
utils_clear_bgp
object
Request to clear BGP sessions on a device
4 properties 2 required
ha_cluster_node_enum15
string
HA cluster node on which to show OSPF interfaces. enum: node0, node1.
utils_service_ping
object
Service ping request for SSR devices
6 properties 2 required
utils_show_ospf_summary
object
OSPF summary command request for SSR and SRX devices
2 properties
ha_cluster_node_enum19
string
HA cluster node on which to show active sessions. enum: node0, node1.
ha_cluster_node_enum22
string
HA cluster node on which to run the device operation. enum: node0, node1.
utils_release_dhcp
object
Request to release the DHCP lease on a device interface
2 properties 1 required
ha_cluster_node_enum7
string
HA cluster node on which to release the DHCP lease. enum: node0, node1.
utils_clear_arp
object
Request to clear ARP entries on a device
5 properties
utils_clear_bgp_type2
string
BGP clear operation type to run. enum: hard, in, out, soft.
response_http404
object
Standard HTTP 404 not found error response
1 property
ha_cluster_node_enum9
string
HA cluster node from which to send the service ping. enum: node0, node1.
response_http403
object
Standard HTTP 403 permission error response
1 property
response_http400
object
Standard HTTP 400 bad request error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
utils_show_ospf_neighbors
object
OSPF neighbors command request for SSR and SRX devices
4 properties
utils_clear_session
object
To use five tuples to lookup the session to be cleared, all must be provided
3 properties
ha_cluster_node_enum17
string
HA cluster node on which to show the OSPF summary. enum: node0, node1.
ha_cluster_node_enum4
string
HA cluster node on which to clear BGP sessions. enum: node0, node1.
websocket_session
object
Response containing the WebSocket session handle for asynchronous command output
1 property 1 required
utils_show_route
object
Route table lookup request for device command output
8 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
websocket_session_with_url
object
Response containing a WebSocket session handle and connection URL
2 properties 2 required
ha_cluster_node_enum5
string
HA cluster node on which to clear sessions. enum: node0, node1.
response_http401
object
Standard HTTP 401 authentication error response
1 property
ha_cluster_node_enum3
string
HA cluster node on which to clear ARP entries. enum: node0, node1.
utils_show_route_protocol2
string
Routing protocol filter for route entries. enum: any, bgp, direct, evpn, ospf, static.
utils_show_ospf_interfaces
object
OSPF interfaces command request for SSR and SRX devices
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

juniper-utilities-wan-api-openapi.yml Raw ↑

Other APIs Juniper Networks publishes across the network.

Junos PyEZ (Python API)
JSNAPy API
Juniper Networks Allowlists and Blocklists API
Juniper Networks Analytics API
Juniper Networks Audit Logs API
Juniper Networks Authentication API
Juniper Networks BGP Routers API
Juniper Networks Blueprints API
Juniper Networks Clients API
Juniper Networks Configlets API
Juniper Networks Configuration API
Juniper Networks Connectivity Templates API
Where this information came from

This is an independent, third-party profile of Juniper Networks 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.