Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesLAN

showSiteDeviceArpTable

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

Get ARP Table from the Device.

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

{    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

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

All attributes are optional

ARP table lookup request for device command output

duration?integer

Refresh duration in seconds; set only when interval is nonzero

Range0 <= value <= 300
Default0
interval?integer

Refresh interval in seconds for repeated command output

Range0 <= value <= 10
Default0
ip?string

Address filter for the ARP table lookup

node?ha_cluster_node_enum

HA cluster node to run the command on, required for Gateways. enum: node0, node1.

Value in

  • "node0"
  • "node1"
port_id?string

Device port identifier filter for the ARP table lookup

vrf?string

Routing instance or VRF filter for the ARP table lookup

Response Body

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

searchSiteDeviceFlowRecords GET

Search network flow records for a specific device within a site. Note: Only supported for switch devices. The device must be manageable. The `device_mac` is automatically scoped to the device in the URL path and cannot be overridden by query parameter.

toogleSiteDeviceVcRoutingEnginesRole POST

In a pre-provisioned VC, mastership is system-determined. This command allows manual toggling between primary and backup Routing Engines.