Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesClientsWired

searchSiteWiredClients

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

Search wired clients for a site with filters for device MAC address, client MAC address, IP address, switch port, VLAN, manufacturer, DHCP attributes, NAC rule, and time range. Use Search Org Wired Clients to search wired clients across the organization.

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

device_mac?string

Filter results by device MAC address

mac?string

Filter results by MAC address

ip?string

Filter results by IP address

port_id?string

Filter results by port identifier

source?string

Filter results by client learning source. enum: lldp, mac

Value in

  • "lldp"
  • "mac"
vlan?string

Filter results by VLAN ID

manufacture?string

Filter results by manufacturer

text?string

Single entry of hostname/mac

nacrule_id?string

Filter results by NAC rule identifier

dhcp_hostname?string

Filter results by DHCP hostname

dhcp_fqdn?string

Filter results by DHCP FQDN

dhcp_client_identifier?string

Filter results by DHCP client identifier

dhcp_vendor_class_identifier?string

DHCP Vendor Class Identifier

dhcp_request_params?string

Filter results by DHCP request parameters

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"
search_after?string

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/wired_clients/search"
{  "end": 1648529800.8221116,  "limit": 1000,  "results": [    {      "auth_method": "mac_auth",      "auth_state": "authenticated",      "device_mac": [        "001122334455"      ],      "dhcp_client_identifier": "MAC address 00155df6d500",      "dhcp_client_options": [        {          "code": "DHO_DHCP_MESSAGE_TYPE(53)",          "data": "DHCPREQUEST"        },        {          "code": "DHO_DHCP_CLIENT_IDENTIFIER(61)",          "data": "MAC address 00155df6d500"        },        {          "code": "DHO_DHCP_REQUESTED_ADDRESS(50)",          "data": "172.17.10.255"        },        {          "code": "DHO_DHCP_SERVER_IDENTIFIER(54)",          "data": "172.17.8.1"        },        {          "code": "DHO_DHCP_MAX_MESSAGE_SIZE(57)",          "data": "1280"        },        {          "code": "DHO_DHCP_PARAMETER_REQUEST_LIST(55)",          "data": " 1 3 6 12 15 28 43 180"        },        {          "code": "DHO_VENDOR_CLASS_IDENTIFIER(60)",          "data": "MSFT 5.0"        },        {          "code": "DHO_HOST_NAME(12)",          "data": "ITS-VMMT0-D1N02"        }      ],      "dhcp_fqdn": "ITS-VMMT0-D1N02.mgthub.local",      "dhcp_hostname": "ITS-VMMT0-D1N02",      "dhcp_request_params": "1 3 6 15 31 33 43 44 46 47 119 121 249 252",      "dhcp_vendor_class_identifier": "MSFT 5.0",      "mac": "112233445566",      "org_id": "c168ddee-c14c-11e5-8e81-1258369c38a9",      "port_id": [        "et-0/0/1"      ],      "site_id": "c168ddee-c14c-11e5-8e81-1258369c38a9",      "timestamp": 1571174567.807,      "vlan": [        0,        1001      ]    }  ],  "start": 1648443400.8221116,  "total": 1}

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.

countSiteWirelessClientEvents GET

Count wireless client events for a site, optionally grouped by the `distinct` field and filtered by event attributes and time range. Use [Count Org Wireless Client Events](/api/mist/orgs/orgs-clients/orgs-clients---wireless/countOrgWirelessClientEvents) to count wireless client events across the organization.