Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesCommon

pingFromDevice

POST
/api/v1/sites/{site_id}/devices/{device_id}/ping

Ping from AP, Switch and SSR

Ping can be performed from the Device. The output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.

Subscribe to Device Command outputs

WS /api-ws/v1/stream

{    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}
Example output from ws stream
{    "event": "data",    "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",    "data": {        "session": "session_id",        "raw": "64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\n"    }}

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid
device_id*string
Formatuuid

Request Body

application/json

Request Body

Request body for running a ping utility command

count?integer

Number of echo requests to send

Default10
egress_interface?string

Interface through which ping packets should egress

host*string

Destination IP address, IPv6 address, or hostname to ping

node?ha_cluster_node_enum

HA cluster node from which to send ping packets. enum: node0, node1.

Value in

  • "node0"
  • "node1"
size?integer

ICMP payload size, in bytes

Range56 <= value <= 65535
Default56
use_ipv6?boolean

applicable when host is hostname

Defaultfalse
vrf?string

Routing instance or VRF through which ping packets are sent

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/ping" \  -H "Content-Type: application/json" \  -d '{    "count": 10,    "host": "1.1.1.1"  }'
{  "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}

monitorSiteDeviceTraffic POST

Monitor traffic on switches and SRX. * JUNOS uses cmd "monitor interface <port>" to monitor traffic on particular <port> * JUNOS uses cmd "monitor interface traffic" to monitor traffic on all ports

readoptSiteOctermDevice POST

For the octerm devices, the device ID must come from fpc0. However, for a VC, the users may change the original fpc0 from CLI. To fix the issue, the readopt API could be used to trigger the readopt process so the device would get the correct device ID to connect the cloud.