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

API Calls to use Devices Troubleshooting tools.Some API Calls can be used with any type of devices (Access Points, Switches and Gateways), and some others may be limited to some types of devices (e.g. "Junos Only")

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

24 operations 24 paths 35 schemas 1 GET23 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 Common 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 24

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

Utilities Common 24

API Calls to use Devices Troubleshooting tools. Some API Calls can be used with any type of devices (Access Points, Switches and Gateways), and some others may be limited to some…

POST
/api/v1/sites/{site_id}/devices/restart
restartSiteMultipleDevices
restartSiteMultipleDevices 1 param body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/arp
arpFromDevice
arpFromDevice 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/bounce_port
bounceDevicePort
bounceDevicePort 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_mac_table
clearSiteDeviceMacTable
clearSiteDeviceMacTable 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_policy_hit_count
clearSiteDevicePolicyHitCount
clearSiteDevicePolicyHitCount 2 params body → 200400401403404429
GET
/api/v1/sites/{site_id}/devices/{device_id}/config_cmd
getSiteDeviceConfigCmd
getSiteDeviceConfigCmd 3 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/locate
startSiteLocateDevice
startSiteLocateDevice 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/monitor_traffic
monitorSiteDeviceTraffic
monitorSiteDeviceTraffic 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/ping
pingFromDevice
pingFromDevice 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/readopt
readoptSiteOctermDevice
readoptSiteOctermDevice 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/release_dhcp_leases
releaseSiteDeviceDhcpLease
releaseSiteDeviceDhcpLease 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/reprovision
readoptSiteOctermDevice
reprovisionSiteOctermDevice 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/request_ztp_password
getSiteDeviceZtpPassword
getSiteDeviceZtpPassword 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/restart
restartSiteDevice
restartSiteDevice 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/shell
createSiteDeviceShellSession
createSiteDeviceShellSession 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_bgp_summary
showSiteDeviceBgpSummary
showSiteDeviceBgpSummary 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_dhcp_leases
showSiteDeviceDhcpLeases
showSiteDeviceDhcpLeases 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_dot1x
showSiteDeviceDot1xTable
showSiteDeviceDot1xTable 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_evpn_database
showSiteDeviceEvpnDatabase
showSiteDeviceEvpnDatabase 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_forwarding_table
showSiteDeviceForwardingTable
showSiteDeviceForwardingTable 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_mac_table
showSiteDeviceMacTable
showSiteDeviceMacTable 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/support
uploadSiteDeviceSupportFile
uploadSiteDeviceSupportFile 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/traceroute
tracerouteFromDevice
tracerouteFromDevice 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/unlocate
stopSiteLocateDevice
stopSiteLocateDevice 2 params → 200400401403404429

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are utils_show_forwarding_table (8 properties), utils_traceroute (8 properties), utils_ping (7 properties), utils_release_dhcp_leases (4 properties). Each schema is shown below with its type and property counts.

utils_send_support_logs
object
3 properties
utils_show_dot1x
object
3 properties
shell_node
object
1 property
strings
array
response_http403
object
1 property
clear_policy_hit_count
object
1 property 1 required
websocket_session_with_url
object
2 properties 2 required
utils_show_dhcp_leases
object
2 properties 1 required
utils_bounce_port
object
1 property
utils_traceroute_protocol
string
enum: icmp (Only supported by AP/MxEdge), udp
root_password_string
object
1 property 1 required
utils_devices_restart
object
2 properties
utils_devices_restart_multi
object
2 properties 1 required
utils_devices_restart_multi_device_ids
array
response_http404
object
1 property
utils_release_dhcp_leases_macs
array
A list of client macs to be released
utils_bounce_port_ports
array
List of ports to bounce
utils_mac_table
object
3 properties
locate_switch
object
2 properties
utils_ping
object
7 properties 1 required
response_http400
object
1 property
utils_show_forwarding_table
object
8 properties
response_http429
object
1 property
utils_traceroute
object
8 properties
utils_release_dhcp_leases
object
Note: valid combinations for Junos: portid macs + network valid combinations for SSR: portid macs + network portid + network network if network or portid is sp…
4 properties 1 required
utils_show_evpn_database
object
4 properties
websocket_session
object
1 property 1 required
response_device_config_cli
object
1 property 1 required
utils_devices_restart_node
string
only for SRX/SSR: if node is not present, both nodes are restarted. For other devices: node should not be present
ha_cluster_node_enum
string
only for HA. enum: node0, node1
utils_monitor_traffic
object
1 property
response_http401
object
1 property
utils_show_bgp_summary
object
1 property
utils_send_support_logs_info
string
Optional, enum: code-dumps: Upload all core dump files, if any found. Uploads for all members of VC on switches. full: Upload 1 file with output of request sup…
ha_cluster_node
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-utilities-common-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 Common
← Back to J APIs
API Details
ID
mist-ai:mist-ai-utilities-common-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