searchSiteWanClients
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 to search WAN clients 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 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
Partial / full Client IP address. Use prefix* for prefix search or *substring* for contains search (e.g. 10.100.10.* and *100.10.* match 10.100.10.54). Suffix-only wildcards (e.g. *.54) are not supported
Filter results by source IP address
Filter results by MAC address
Filter results by manufacturer
Partial / full Name of the network the client is/was connected to. Use prefix* for prefix search or *substring* for contains search (e.g. my-corp* and *corp* match my-corp-network). Suffix-only wildcards (e.g. *corp) are not supported
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/search"{ "end": 0, "limit": 0, "results": [ { "hostname": [ "sonoszp" ], "ip": [ "192.168.1.139" ], "last_hostname": "sonoszp", "last_ip": "192.168.1.139", "mfg": "Sonos", "org_id": "b4e16c72-d50e-4c03-a952-a3217e231e2c", "site_id": "f688779c-e335-4f88-8d7c-9c5e9964528b", "wcid": "8bbe7389-212b-c65d-2208-00fab2017936" } ], "start": 0, "total": 0}searchSiteWanClientEvents GET
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](/api/mist/orgs/orgs-clients/orgs-clients---wan/searchOrgWanClientEvents) to search WAN client events across the organization.
countSiteWiredClients GET
Count wired clients for a site, optionally grouped by the `distinct` field and filtered by MAC address, switch port, VLAN, and time range. Use [Count Org Wired Clients](/api/mist/orgs/orgs-clients/orgs-clients---wired/countOrgWiredClients) to count wired clients across the organization.