Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Clients

Get Client Details

This API endpoint retrieves detail of Client, based on the query parameters provided. Client detail includes clientName, status, ipv4, etc.

get/network-monitoring/v1/clients/{mac-address}

Path parameters

mac-addressstring const required
Example:05:50:35:a1:a0:01

MAC address of the Wireless/Wired Client to be queried

Response

Response schema for client details

clientNamestring

Specifies the name of the client.

status'Connected' | 'Failed' | 'Connecting' | 'Disconnected' | 'Blocked'

Specifies the status of the client.

clientConnectionType'Wired' | 'Wireless'

Specifies the client type.

macAddressstring

Specifies the MAC address of the client.

ipv4string

Specifies the IPv4 address of the client.

ipv6string

Specifies the IPv6 address of the client.

connectedDeviceSerialstring

Specifies the serial number of the connected device.

connectedTostring

Specifies the device name that the client is connected to.

lastSeenAtstring date-time

The date and time when the client was last detected in the system. If the client is online, this value will be 0.

wlanNamestring

Specifies the network identifier.

portstring

Specifies the port to which the client is connected, or null if not applicable.

rolestring

Specifies the role of the client.

vlanNamestring

Specifies the VLAN name associated with the client.

vlanIdstring

Specifies the VLAN ID associated with the client.

tunnelTypestring

Specifies the tunnel type associated with the client. Possible values are "Port-based", "User-based", "Overlay", and "None". "None" indicates no tunnel.

tunnelIdinteger

Specifies the tunnel ID associated with the client.

connectedAtstring date-time

Specifies the timestamp when the client was connected.

keyManagementstring

Security mode used by the client.

authenticationTypestring

Authentication type used by the client to connect with the device.

clientCapabilitiesstring

Client 802.11 capabilities.

userNamestring

The client's username.

hostNamestring

The client's hostname.

connectedDeviceTypestring

Type of connected device (AP/Switch/Gateway).

wirelessSecuritystring

Specifies the wireless security protocol used by the client.

clientManufacturerstring

Specifies the manufacturer of the client device.

clientFunctionstring

Specifies the functional category of the client device.

clientVendorstring

Specifies the vendor of the client device.

clientOperatingSystemstring

OS model of the client device.

clientTagsstring

Comma-separated tags associated with the client.

clientCategorystring

Specifies the category of the client device.

siteNamestring

The name of the site where the client is located.

siteIdstring

A unique identifier for the site where the client is located.

wirelessBandstring

Wireless frequency band used by the client.

wirelessChannelstring

The wireless channel number on which the client is operating.

bssidstring

The BSSID to which the client is connected on the device.

radioMacAddressstring

The radio MAC address to which the client is connected on the device.

typestring const required

The type of the resource.

idstring const required

Primary identifier for the resource.

snrinteger

Specifies the signal-to-noise ratio (SNR) of the client's wireless connection. Higher values indicate better signal quality.

mloOperModestring

Specifies the Multi-Link Operation (MLO) mode used by the client for Wi-Fi 7 connectivity.

phyTypestring

Specifies the IEEE 802.11 physical layer standard used for the client's current connection.

Example response

{
  "clientName": "Client1",
  "status": "Connected",
  "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",
  "vlanName": "100",
  "vlanId": "100",
  "tunnelType": "Overlay",
  "connectedAt": "2025-07-10T08:09:17.419Z",
  "keyManagement": "WPA2_PSK",
  "authenticationType": "Captive Portal",
  "clientCapabilities": "802.11ac",
  "userName": "user",
  "hostName": "13_B3_20_22_B0_04H",
  "connectedDeviceType": "AP",
  "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",
  "type": "network-monitoring/client-monitoring",
  "id": "c8:b5:ad:c3:b2:04",
  "snr": 42,
  "mloOperMode": "MLO Disabled",
  "phyType": "802.11a"
}