API
Obtain client of the device
Avaliable in 8.0.1 or later
Input Parameters
| Type | Notation | Mandatory | Description | |
| vlanId | Number | <integer> | optional | Filter out the clients which are not provided. If the field is not provided, all VLAN ID and untagged LAN client will be shown. |
| activeOnly | String | { yes, no } | optional | Filter out the clients which are not active. If the field is not provided, active and inactive client will be shown. |
| connectionType | Array | list of { ethernet, wireless, pptp, stroute, l2tp, openvpn, pepvpn, other } | optional | Filter out the clients which are not provided in the array |
| size | Number | [ 1, 10000000 ] | optional | Limited the number of client return. If the field is not provided, 1000 clients will be return. |
| outputWeight | String | { full, normal, lite } | optional | Filter of the content size. full – return all the information which is object can provide. normal – return ip, connectionType, clientType, name, mac, bssid, vlanId, essid and active lite – return ip, connectionType, clientType, name, mac, bssid and vlanI |
| infoType | Array | list of { ip, connectionType, lease, name, mac, bssid, port, vlanId, essid, active, signalStrength, speed } | optional | Filter of the content size. This field will override the outputWeight param. If both outputWeight and infoType are absent, the content will outputWeight=normal. |
Return Parameters
Return JSON
| Type | Notation | Description | |
| list | Array | list of <Client_Obj> | The list of the client object. |
<Client_Obj>
| Type | Notation | Description | |
| ip | String | <ipv4> | IP address |
| connectionType | String | { ethernet, wireless, pptp, stroute, l2tp, openvpn, pepvpn, other } | Connection Type of the client If the client is not active, this param will be absent. In fw 8.1.0 or before, it return ‘ethernet’ accidentally. Better check the ‘active’ param before this. |
| lease | Object | <Lease_Obj> | Lease type and expires in second The field only available when the connectionType is ethernet or wireles |
| name | String | <string> | The name of the drive if any. |
| mac | String | <mac> | MAC address of the client |
| bssid | String | <mac> | BSSID of the Wi-Fi. This field only present when connectionType=wireless |
| vlanId | Number | <integer> | Which VLAN the client connected. When it connects to untagged LAN, this field will be absent. |
| essid | String | <string> | SSID of the Wi-Fi. This field only present when connectionType=wireless |
| active | Boolean | <boolean> | The active state of the client |
| signalStrength | Object | <signal_Obj> | Signal Strength information Deprecated in fw 8.1.0 |
| signal | Object | <signal_Detail_Obj> | Signal Strength and Level information First present in fw 8.1.0 |
| speed | Object | <Bandwidth_Obj> | Speed information |
<Lease_Obj>
| Type | Notation | Description | |
| expiresIn | Number | <integer> | Lease expires in second |
| type | String | { normal, dhcp, wins } | Lease Type |
<Signal_Obj>
| Type | Notation | Description | |
| value | Number | <number> | Strength of the Wi-Fi signal |
| unit | String | { dBm } | Unit of the signal |
<Signal_Detail_Obj>
| Type | Notation | Description | |
| strength | Number | <number> | Strength of the Wi-Fi signal in dBm |
| level | Number | [ 1,5 ] | Signal Level |
<Bandwidth_Obj>
| Type | Notation | Description | |
| download | Number | <number> | Download rate |
| upload | Number | <number> | Upload rate |
| unit | String | { kbps } | Unit of the speed |
cURL Example
curl -b cookies.txt http://192.168.1.1/api/status.client?connectionType=ethernet wireless
{
"stat": "ok",
"response": {
"list": [
{
"ip": "192.168.50.4",
"connectionType": "wireless",
"name": "Android client",
"mac": "9C:5C:F9:2B:85:99",
"bssid": "00:1A:DD:ED:8F:69",
"essid": "PEPWAVE_D3B1",
"active": true
},
{
"ip": "192.168.50.11",
"connectionType": "ethernet",
"name": "macOS client",
"mac": "E4:25:E7:8A:D3:12",
"active": false
},
{
"ip": "192.168.50.17",
"connectionType": "wireless",
"name": "iOS client",
"mac": "34:12:98:9B:11:D7",
"active": false
}
]
}
}