SitesWAN Usages

searchSiteWanUsage

GET
/api/v1/sites/{site_id}/wan_usages/search

Search Site WAN Usages

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

Query Parameters

mac?string

Filter results by MAC address

peer_mac?string

Filter results by peer MAC address

port_id?string

Port ID for the device

peer_port_id?string

Peer Port ID for the device

policy?string

Filter results by WAN path policy

tenant?string

Filter results by tenant network

path_type?string

Filter results by port path type

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/wan_usages/search"
{  "end": 0,  "limit": 0,  "results": [    {      "mac": "5c5b35000001",      "path_type": "vpn",      "path_weight": 10,      "peer_mac": "0200018c95e1",      "peer_port_id": "ge-0/0/3",      "policy": "policy1",      "port_id": "ge-0/0/0.0",      "tenant": "tenant1"    }  ],  "start": 0}