showSiteDeviceDhcpLeases
Shows DHCP leases
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
uuiduuidRequest Body
application/json
DHCP leases command request
DHCP network for the leases, returns full table if not specified
HA cluster node on which to show DHCP leases. enum: node0, node1.
Value in
- "node0"
- "node1"
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/show_dhcp_leases" \ -H "Content-Type: application/json" \ -d '{ "network": "guest" }'{ "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}showSiteDeviceBgpSummary POST
Get BGP Summary from SSR, SRX and Switch. 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 ``` Tue 2024-04-23 16:36:06 UTC Retrieving bgp entries... BGP table version is 354, local router ID is 10.224.8.16, vrf id 0 Default local pref 100, local AS 65000 Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, i internal, r RIB_failure, S Stale, R Removed Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self Origin codes: i - IGP, e - EGP, ? - incomplete RPKI validation codes: V valid, I invalid, N Not found Network Next Hop Metric LocPrf Weight Path *> 161.161.161.0/24 ```"
showSiteDeviceDot1xTable POST
Get Dot1X 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` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ```