searchSiteWanClientEvents
Search WAN client events for a site with filters for client identity, manufacturer, NAC rule, event type, and time range. Use Search Org WAN Client Events to search WAN client events across the organization.
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
uuidQuery Parameters
Partial / full Client MAC address. Use prefix* for prefix search or *substring* for contains search (e.g. aabbcc* and *bbcc* match aabbccddeeff). Suffix-only wildcards (e.g. *bccddeeff) are not supported
Partial / full Client hostname. Use prefix* for prefix search or *substring* for contains search (e.g. everest* and *rest* match my-everest-client). Suffix-only wildcards (e.g. *everest) are not supported
Filter results by IP address
Filter results by manufacturer
Filter results by NAC rule identifier
Maximum number of results to return per page
0 <= value100Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"On which field the list should be sorted, -prefix represents DESC order
"timestamp"Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.
Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/wan_clients/events/search"{ "end": 0, "limit": 0, "results": [ { "When": "2022-12-31 23:59:59.293000+00:00", "ev_type": "CLIENT_IP_ASSIGNED", "metadata": {}, "org_id": "b0b9f142-aaba-11e6-aafc-0242ac110002", "random_mac": true, "site_id": "fc656275-b157-43fd-b922-5f4f341c19bf", "text": "DHCP Ack IP 192.168.88.216", "wcid": "62bbfb75-10d8-49d1-dec7-d2df91624287" } ], "start": 0, "total": 0}countSiteWanClients GET
Count WAN clients for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org WAN Clients](/api/mist/orgs/orgs-clients/orgs-clients---wan/countOrgWanClients) to count WAN clients across the organization.
searchSiteWanClients GET
Search WAN clients for a site with filters for hostname, IP address, source IP, MAC address, manufacturer, network, and time range. Use [Search Org WAN Clients](/api/mist/orgs/orgs-clients/orgs-clients---wan/searchOrgWanClients) to search WAN clients across the organization.