UtilitiesWAN

clearSiteSsrArpCache

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

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

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 ARP entries on a device

ip?string

The IP address for which to clear an ARP entry. port_id must be specified.

node?ha_cluster_node_enum

HA cluster node on which to clear ARP entries. enum: node0, node1.

Value in

  • "node0"
  • "node1"
port_id?string

The device interface on which to clear the ARP cache.

vlan?integer

The VLAN on which to clear the ARP cache. port_id must be specified.

vrf?string

The vrf for which to clear an ARP entry. applicable for switch.

Response Body

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