Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesCommon

releaseSiteDeviceDhcpLease

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

Releases an active 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

Note:

  • valid combinations for Junos:
    • port_id
    • macs + network
  • valid combinations for SSR:
    • port_id
    • macs + network
    • port_id + network
    • network
  • if network or port_id is specified and macs is empty, it means all clients under network or port_id
macs?array<string>

Client MAC addresses whose DHCP leases should be released

network?string

DHCP network containing the leases to release

node?ha_cluster_node_enum

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

Value in

  • "node0"
  • "node1"
port_id*string

Network interface containing the DHCP leases to release

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_leases" \  -H "Content-Type: application/json" \  -d '{    "port_id": "ge-0/0/1.10"  }'
Empty

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.

readoptSiteOctermDevice POST

To force one device to reprovision itself again.