v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Clients

List Unified Clients

This API endpoint retrieves a list of Clients, based on the query parameters provided. Clients list includes details like clientName, status, clientConnectionType, etc., The query parameters allow you to narrow down the results that meet specific criteria, ensuring you receive only the relevant data.

get/network-monitoring/v1/clients

Query parameters

site-idstring const

Example:12345367

The ID of the site from which the clients are to be retrieved.

site-namestring const

Example:site_name1

The name of the site from which the clients are to be retrieved.

serial-numberstring const

Example:QWR124780123

Specifies the device identifier.

start-atstring const

Example:2025-07-10T08:09:17.419Z

Start timestamp in RFC 3339 date-time string. Must be less than end-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, the interval must be ≤ 1 month. Default is end-at - 3 hours. The query parameters start-at and end-at only impacts failed clients.

end-atstring const

Example:2025-07-10T08:11:17.419Z

End timestamp in RFC 3339 date-time format. Must be later than start-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, it must be ≤ 1 month. Default is the current timestamp.

filterstring

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). By default, status eq 'Connected' filter is applied. To retrieve clients with a different status, explicitly specify the status in the filter. If other filters are provided without status, the default connected status filter is still applied. Supported fields and operators are in the below given table.

Field	Operators
clientConnectionType	eq and in
status	eq and in
wlanName	eq and in
vlanId	eq and in
tunnelType	eq and in
role	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

List of applicable filters for field and terms:

Field	Applicable Terms
clientConnectionType	["Wired", "Wireless"]
status	["Connected", "Failed"]
wlanName	string
vlanId	string
tunnelType	["Port-based", "User-based", "Overlay"]
role	string

sortstring const

Example:clientName asc

Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are clientName,status,clientConnectionType,macAddress,ipv4,ipv6,connectedDeviceSerial,connectedTo,lastSeenAt,port,role,wlanName,vlanId,tunnelType,tunnelId,connectedAt

nextstring

Specifies the pagination cursor for the next page of resources. Minimum value is 1

limitinteger

Maximum number of clients to be retrieved. Allowed range is 1 to 1000.

Response

Response schema for listing clients

countinteger required

The number of clients after filtering

totalinteger

Total number of clients

nextstring

Specifies the pagination cursor for the next page of resources. null if there are no further pages.

Example response

{
  "items": [
    {
      "clientName": "Client1",
      "status": "Connected",
      "connectedDeviceType": "AP",
      "clientConnectionType": "Wireless",
      "macAddress": "05:50:35:a1:a0:01",
      "ipv4": "129.110.213.218",
      "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "connectedDeviceSerial": "DTXC000001",
      "connectedTo": "20:4c:03:a4:a4:28",
      "wlanName": "wlan-00001",
      "role": "wireless",
      "vlanId": "100",
      "vlanName": "100",
      "tunnelType": "Overlay",
      "connectedAt": "2025-07-10T08:09:17.419Z",
      "userName": "user",
      "hostName": "13_B3_20_22_B0_04H",
      "wirelessSecurity": "WPA2-Enterprise",
      "clientManufacturer": "Samsung",
      "clientFunction": "Mobile",
      "clientVendor": "Android",
      "clientOperatingSystem": "Android",
      "clientTags": "tag1",
      "clientCategory": "Smart Device",
      "siteName": "Site-1",
      "wirelessBand": "5GHZ",
      "bssid": "b8:3a:5a:47:29:41",
      "radioMacAddress": "b8:3a:5a:46:ed:30",
      "keyManagement": "WPA2_PSK",
      "authenticationType": "Captive Portal",
      "clientCapabilities": "802.11ac",
      "type": "network-monitoring/client-monitoring",
      "id": "c8:b5:ad:c3:b2:04",
      "snr": 42,
      "mloOperMode": "MLO Disabled",
      "phyType": "802.11a"
    }
  ]
}