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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Juniper Networks

Juniper Networks 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 Networks Utilities Common 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 Common. 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 24 operations across 24 paths, and defines 38 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.

24 operations 24 paths 38 schemas 1 GET23 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
Contact
Thomas Munzer
Resource Areas
1

Authentication & Security 2

Juniper Networks Utilities Common 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 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
reprovisionSiteOctermDevice
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 38

The contract defines 38 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_show_dhcp_leases
object
DHCP leases command request
2 properties 1 required
ha_cluster_node
object
HA cluster node selector for device operations
1 property
ha_cluster_node_enum13
string
HA cluster node on which to show the forwarding table. enum: node0, node1.
utils_traceroute
object
Request body for running a traceroute utility command
8 properties
utils_show_forwarding_table
object
Forwarding table lookup request for device command output
8 properties
ha_cluster_node_enum12
string
HA cluster node on which to show DHCP leases. enum: node0, node1.
ha_cluster_node_enum11
string
HA cluster node on which to show the BGP summary. enum: node0, node1.
utils_mac_table
object
MAC table lookup filters
3 properties
utils_show_evpn_database
object
EVPN database lookup request for device command output
4 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_send_support_logs_info2
string
Support file bundle type to upload. enum: code-dumps, full, messages, outbound-ssh, process, var-logs.
ha_cluster_node_enum20
string
HA cluster node from which to run traceroute. enum: node0, node1.
root_password_string
object
Temporary root password response for device ZTP recovery
1 property 1 required
response_device_config_cli
object
Device configuration rendered as CLI commands
1 property 1 required
ha_cluster_node_enum22
string
HA cluster node on which to run the device operation. enum: node0, node1.
clear_policy_hit_count
object
Request body for clearing hit counters on an application policy
1 property 1 required
utils_bounce_port
object
Request to bounce one or more device ports
1 property
utils_devices_restart
object
Request to restart a device or device node
2 properties
utils_monitor_traffic
object
Request body for monitoring traffic on one port or all ports
1 property
response_http404
object
Standard HTTP 404 not found error response
1 property
utils_show_dot1x
object
802.1X table lookup request for device command output
3 properties
utils_traceroute_protocol2
string
Transport protocol to use for traceroute. enum: icmp, udp.
locate_switch
object
Request body for locating a switch or virtual chassis member by MAC address for a limited duration
2 properties
ha_cluster_node_enum8
string
HA cluster node on which to release DHCP leases. 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
utils_ping
object
Request body for running a ping utility command
7 properties 1 required
response_http429
object
Standard HTTP 429 rate limit error response
1 property
websocket_session
object
Response containing the WebSocket session handle for asynchronous command output
1 property 1 required
websocket_session_with_url
object
Response containing a WebSocket session handle and connection URL
2 properties 2 required
utils_devices_restart_multi
object
Request to restart multiple devices
2 properties 1 required
ha_cluster_node_enum2
string
HA cluster node on which to create the shell session. enum: node0, node1.
utils_devices_restart_node2
string
SRX or SSR node to restart. enum: node0, node1.
response_http401
object
Standard HTTP 401 authentication error response
1 property
utils_show_bgp_summary
object
BGP summary command request
1 property
ha_cluster_node_enum6
string
HA cluster node from which to send ping packets. enum: node0, node1.
shell_node
object
Request body for creating a shell session on a specific HA node
1 property
utils_send_support_logs
object
Request to upload support files from a device
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Juniper Networks publishes across the network.

Junos PyEZ (Python API)
AE Profile APIs.io
JSNAPy API
AE Profile APIs.io
Juniper Networks Allowlists and Blocklists API
AE Profile APIs.io
Juniper Networks Analytics API
AE Profile APIs.io
Juniper Networks Audit Logs API
AE Profile APIs.io
Juniper Networks Authentication API
AE Profile APIs.io
Juniper Networks BGP Routers API
AE Profile APIs.io
Juniper Networks Blueprints API
AE Profile APIs.io
Juniper Networks Clients API
AE Profile APIs.io
Juniper Networks Configlets API
AE Profile APIs.io
Juniper Networks Configuration API
AE Profile APIs.io
Juniper Networks Connectivity Templates API
AE Profile APIs.io
#Utilities Common
← Back to J APIs
API Details
ID
juniper:juniper-utilities-common-api
Base URL
netconf://[device-ip]:830
Docs
https://www.juniper.net/documentation/product/us/en/junos-pyez/
Provider
Juniper Networks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=juniper-utilities-common-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/juniper-utilities-common-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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