Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesWAN

releaseSiteSsrDhcpLease

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

Releases an active DHCP lease.

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

Example output from ws stream

{    "event": "data",    "channel": "/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0000-1000-0200010edbca/cmd",    "data": "{\"event\": \"data\", \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/0200010edbca/cmd\",\"data\": {\"session\": \"356b2150-7307-4165-8411-52794c1ee8b0\",\"raw\": \"Releasing dhcp...\"}}"}{    "event": "data",    "channel": "/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0000-1000-0200010edbca/cmd",    "data": "{\"event\": \"data\", \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-a8d7b85087ac/devices/0200010edbca/cmd\",\"data\": {\"session\": \"356b2150-7307-4165-8411-52794c1ee8b0\",\"raw\": \"Successfully released DHCP lease.\"}}"}

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 to release the DHCP lease on a device interface

node?ha_cluster_node_enum

HA cluster node on which to release the DHCP lease. enum: node0, node1.

Value in

  • "node0"
  • "node1"
port_id*string

Network interface whose current DHCP lease should be released

Length1 <= length

Response Body

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

clearSiteBgpRoutes POST

Clear routes associated with one or all BGP neighbors

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" } ```