Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesWAN

clearSiteBgpRoutes

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

Clear routes associated with one or all BGP neighbors

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 clear BGP sessions on a device

neighbor*string

can be ip, ipv6, all

Default"all"
node?ha_cluster_node_enum

HA cluster node on which to clear BGP sessions. enum: node0, node1.

Value in

  • "node0"
  • "node1"
type*utils_clear_bgp_type

BGP clear operation type to run. enum: hard, in, out, soft.

Default"hard"

Value in

  • "hard"
  • "in"
  • "out"
  • "soft"
vrf?string

Routing instance or VRF containing the BGP session

Response Body

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

clearSiteSsrArpCache POST

Clear ARP cache for SSR, SRX and Switch Clear the entire ARP cache or a subset if arguments are provided. *Note*: port_id is optional if neither vlan nor ip is specified

releaseSiteSsrDhcpLease POST

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` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ```json { "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.\"}}" } ```