# Juniper Networks Utilities Common API

**Canonical:** https://apis.io/apis/juniper/juniper-utilities-common-api/  
**Provider:** Juniper Networks — https://apis.io/providers/juniper/  
**Base URL:** netconf://[device-ip]:830  
**Documentation:** https://www.juniper.net/documentation/product/us/en/junos-pyez/

Juniper Networks Utilities Common API is one of 263 APIs that [Juniper Networks](https://apis.io/providers/juniper/) publishes on the [APIs.io](https://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.

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")

## Operations (24)

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

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/openapi/juniper-utilities-common-api-openapi.yml
- **GitHub** — https://github.com/mistsys/mist_openapi
- **APIReference** — https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/overview/overview
- **Documentation** — https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html
- **GettingStarted** — https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/asyncapi/juniper-mist-webhooks.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/rate-limits/juniper-rate-limits.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/errors/juniper-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/conventions/juniper-conventions.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/data-model/juniper-data-model.yml
- **StatusPage** — https://mist.statuspage.io/

## Other Juniper Networks APIs (12)

- [Junos PyEZ (Python API)](https://apis.io/apis/juniper/junos-pyez-python-api/)
- [JSNAPy API](https://apis.io/apis/juniper/jsnapy-api/)
- [Juniper Networks Allowlists and Blocklists API](https://apis.io/apis/juniper/juniper-allowlists-and-blocklists-api/)
- [Juniper Networks Analytics API](https://apis.io/apis/juniper/juniper-analytics-api/)
- [Juniper Networks Audit Logs API](https://apis.io/apis/juniper/juniper-audit-logs-api/)
- [Juniper Networks Authentication API](https://apis.io/apis/juniper/juniper-authentication-api/)
- [Juniper Networks BGP Routers API](https://apis.io/apis/juniper/juniper-bgp-routers-api/)
- [Juniper Networks Blueprints API](https://apis.io/apis/juniper/juniper-blueprints-api/)
- [Juniper Networks Clients API](https://apis.io/apis/juniper/juniper-clients-api/)
- [Juniper Networks Configlets API](https://apis.io/apis/juniper/juniper-configlets-api/)
- [Juniper Networks Configuration API](https://apis.io/apis/juniper/juniper-configuration-api/)
- [Juniper Networks Connectivity Templates API](https://apis.io/apis/juniper/juniper-connectivity-templates-api/)

## Tags

Utilities Common

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/juniper/juniper-utilities-common-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/juniper/.