Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesWAN

servicePingFromSsr

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

Ping from SSR

Service Ping can be performed from the Device. The output will be available through websocket. As there can be multiple command issued against the same device 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

Service ping request for SSR devices

count?integer

Number of ICMP echo requests to send for the service ping

Default10
host*string

Destination IPv4 address for the service ping

Formatipv4
node?ha_cluster_node_enum

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

Value in

  • "node0"
  • "node1"
service*string

Ping packet takes the same path as the service

size?integer

ICMP payload size, in bytes

Range56 <= value <= 65535
Default56
tenant?string

Routing tenant context in which the packet is sent

Response Body

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

runSiteSrxTopCommand POST

Run top command on switches and SRX. The output will be available through websocket. As there can be multiple commands issued against the same device 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` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ```

showSiteGatewayOspfDatabase POST

Get OSPF Database from SSR and SRX. The output will be available through websocket. As there can be multiple commands issued against the same device 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` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ``` ===== ==================== ========== ======= ======== ================ =================== ================= Vrf Neighbor Router ID Priority State Uptime Dead Timer Due Interface Address Interface State ===== ==================== ========== ======= ======== ================ =================== ================= 1.0.0.3 1 Full 852 38 172.16.3.2 Backup 1.0.0.4 1 Full 811 33 172.16.3.2 DROther 1.0.0.3 1 Full 852 38 172.16.4.2 Backup 1.0.0.4 1 Full 811 34 172.16.4.2 DROther ```