Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsClientsWired

searchOrgWiredClients

GET
/api/v1/orgs/{org_id}/wired_clients/search

Search for Wired Clients in org

Note: For list of available type values, please refer to List Client Events Definitions

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

org_id*string
Formatuuid

Query Parameters

auth_state?string

Filter results by auth state

auth_method?string

Filter results by authentication method. Accepts multiple comma-separated values.

source?string

Filter results by client learning source. enum: lldp, mac. Accepts multiple comma-separated values.

site_id?string

Filter results by site identifier

device_mac?string

Filter results by one or more gateway or switch MAC addresses where the client has connected. Supports comma-separated values

mac?string

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. Accepts multiple comma-separated values.

port_id?string

Filter results by one or more port identifiers where the client has connected. Supports comma-separated values

vlan?string

Filter results by one or more VLAN IDs. Supports comma-separated values

ip?string

Filter results by one or more IPv4 addresses. Supports comma-separated values

manufacture?string

Filter results by manufacturer. Accepts multiple comma-separated values.

text?string

Partial / full Client MAC address, hostname or username. Use prefix* for prefix search or *substring* for contains search (e.g. aabbcc* and *bbcc* match aabbccddeeff). Suffix-only wildcards (e.g. *ddeeff) are not supported

nacrule_id?string

Filter results by NAC rule identifier

dhcp_hostname?string

Filter results by DHCP hostname. Accepts multiple comma-separated values.

dhcp_fqdn?string

Filter results by DHCP FQDN

dhcp_client_identifier?string

Filter results by DHCP client identifier. Accepts multiple comma-separated values.

dhcp_vendor_class_identifier?string

DHCP Vendor Class Identifier. Accepts multiple comma-separated values.

dhcp_request_params?string

Filter results by DHCP request parameters. Accepts multiple comma-separated values.

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/orgs/000000ab-00ab-00ab-00ab-0000000000ab/wired_clients/search?source=lldp%2Cmac"
{  "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}

countOrgWiredClients GET

Count by Distinct Attributes of Clients Note: For list of available `type` values, please refer to [List Client Events Definitions](/api/mist/constants/constants-events/listClientEventsDefinitions)

countOrgWirelessClientEvents GET

Count wireless client event records across the organization, optionally grouped by event attributes and filtered by event type, WLAN, radio, site, and time range.