api:networkmanagement:device:clients
Table of Contents
API : Network Device Clients
Introduction
This request will return a list of clients currently connected to the device.
Request
| URL | https://api.telecomx.dk/network/device/DEVICE_ID/clients | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER, OWNER RESELLER if customer belongs to the reseller or a sub reseller. RESELLER_ADMIN, ADMIN. |
|
| Params | DEVICE_ID | Id of the network device. |
Query examples
https://api.telecomx.dk/network/device/12345678901234867890ABCD/clients
Response
| JSON object | ||
|---|---|---|
| Property | Type | Description |
| errorCode | Number | Indicates if the request was a success, |
| msg | String | Success message. |
| result | Array | List of clients. |
| name | String | |
| ip | String | IP address of the client |
| ipv6 | String | Optional IPv6 address of the client |
| status | String | Status of the client |
| vendor | String | Vendor of the client |
| mac | String | MAC address of the client |
| alertCount | Number | Alert count of the client, per 15 minutes |
| alarmCount | Number | Alarm count of the client, per 24 hours |
| connectType | String | Connection type of the client, WIRED or WIRELESS |
| wifiStandard | String | Wifi standard of the client: Wi-Fi4, Wi-Fi5, Wi-Fi6, Wi-Fi7 |
| connectBand | String | Connection band of the client: 2.4GHz, 5GHz, 6GHz |
| connectNetwork | String | Connection network of the client: Main or guest network |
| linkRate | Number | Link rate of the client |
| maxLinkRate | Number | Maximum link rate of the client |
| snr | Number | Signal to Noise Ratio of the client, in dB |
| rssi | Number | Received Signal Strength Indicator of the client, in dBm |
| upstream | Number | |
| downstream | Number | |
| connectDeviceName | String | Connection device name of the client |
| duration | Number | Duration the client has been online, in seconds |
| lastOfflineTime | Number | Last offline time of the client, in epoch time |
| clientType | String | Client type: pc, phone, laptop, entertainment, printer, android, pad, ipad, router, ip_camera, iot_device, other. |
| efficiency | String | Link efficiency of the client, calculated as linkRate/maxLinkRate |
| wiredLANPort | String | Wired LAN port of the client, null for wireless devices |
Note that properties holding no value may be omitted from the object.
Example - normal
N/A
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | device | Not found |
| 500 | internal_error | <Unspecified> |
api/networkmanagement/device/clients.txt · Last modified: 2025/10/30 08:14 by Per Møller