v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Client

Get client info

Get client detailed information.

get/clients/{id}

Path parameters

idinteger required

The client ID

Query parameters

viewsXiqClientView[]

The views to return client fields (Check fields for each view at XiqClientView schema)

fieldsXiqClientField[]

The client fields to return

Response

OK

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

org_idinteger

The organization identifier, valid when enabling HIQ feature

location_idinteger

The location ID

device_idinteger

The device ID

hostnamestring

The hostname of the client

mac_addressstring

The MAC address of the client

ip_addressstring

The IP address of the client

ipv6_addressstring

The IPv6 address of the client

os_typestring

The OS type of the client

usernamestring

The username of the client.

user_profile_namestring

The user profile name of the client

connectedboolean

Client is connected or not

online_timestring date-time

The online time for the client

offline_timestring date-time

The offline time for the client

vlaninteger

The associate VLAN

connection_typeinteger

The connection type

ssidstring

The SSID

portstring

The associate device port

org_namestring

The organization name

device_functioninteger

The associated device function

device_mac_addressstring

The associated device mac address

device_namestring

The associated device name

authinteger

The authentication type

channelinteger

The channel value

client_healthinteger

The health score of client

application_healthinteger

The health score of application

radio_healthinteger

The health score of radio

network_healthinteger

The health score of network

radio_typeinteger

The radio type. Represented by an integer code for each standard:<br> 1 - 2.4G<br> 2 - 5G<br> 3 - WIRED<br> 4 - 6G<br> 5 - THREAD

encryption_methodinteger

The encryption method, represented by an integer code for each encryption type:<br>-1 - N/A (Not applicable)<br>0 - AES (Advanced Encryption Standard)<br>1 - TKIP (Temporal Key Integrity Protocol)<br>2 - WEP (Wired Equivalent Privacy)<br>3 - NON (No encryption)<br>4 - CCMP (Counter Mode with Cipher Block Chaining Message Authentication Code Protocol)<br>5 - KEYGUARD (Keyguard encryption)<br>6 - WEP128 (128-bit WEP encryption)<br>7 - WEP64 (64-bit WEP encryption)<br>8 - WAPI (WLAN Authentication and Privacy Infrastructure)<br>9 - GCMP256 (256-bit Galois/Counter Mode Protocol)<br>10 - NONE (No encryption)<br>11 - PAP (Password Authentication Protocol)<br>12 - MsCHAP (Microsoft Challenge Handshake Authentication Protocol)<br>13 - EAP-MD5 (Extensible Authentication Protocol - MD5)<br>14 - EAP-TLS (Extensible Authentication Protocol - Transport Layer Security)<br>15 - PEAP (Protected Extensible Authentication Protocol)<br>16 - TTLS (Tunneled Transport Layer Security)<br>17 - TTLS-INNER-TUNNEL (Inner tunnel for TTLS)<br>18 - PEAP-INNER-TUNNEL (Inner tunnel for PEAP)<br>19 - EAP-FAST (Extensible Authentication Protocol - Flexible Authentication via Secure Tunneling)<br>20 - EAP-LEAP (Lightweight Extensible Authentication Protocol)<br>21 - EAP-RSA (Extensible Authentication Protocol - RSA)<br>22 - EAP-SIM (Extensible Authentication Protocol - SIM)<br>23 - EAP-AKA (Extensible Authentication Protocol - AKA)<br>24 - EAP-TEAP (Extensible Authentication Protocol - Tunneled EAP)

mac_protocolstring

The MAC protocol of the client:<br>'N/A'<br>'802.11a'<br>'802.11b'<br>'802.11g'<br>'802.11na'<br>'802.11ng'<br>'802.11ac'<br>'802.11ax-2.4g'<br>'802.11ax-5g'<br>'802.3'<br>'802.11ax-6g'<br>'802.15.4'<br>'802.11be-2g'<br>'802.11be-5g'<br>'802.11be-6g'

interface_namestring

The interface name

bssidstring

The bssid

rssiinteger

The RSSI

snrinteger

The SNR

descriptionstring

The description of client

categorystring

The category of client

mobilitystring

The client mobility

port_type_namestring

The client port type name

wing_apboolean

Wing ap flag

vendorstring

The vendor of client

product_typestring

The Category which describes the Extreme device types(For example:For example:SR_2208P, AP_4000, AP_5010)

aliasstring

The alias of the client

th_rloc16string

The thread client Rloc16

th_child_idinteger

The thread client child ID

th_timeoutinteger

The thread client timeout

th_supervision_intervalinteger

The thread client Super vision interval

th_netdata_versioninteger

The thread client netdata version

th_csl_syncedboolean

The thread client CSL synced

th_router_last_reportedstring date-time

The last reported datetime by thread router

thread_connectedboolean

Is client connected to thread network

makestring

The Manufacturer of the client associated device

os_versionstring

The OS version of the client associated device

connected_tostring

The device name which client is connected to

connection_durationinteger

The client's connection duration

captive_web_portalstring

Captive Web Portal