Get Connected Client Details
Retrieve detailed information about a specific connected client, including name, IP address, MAC address, connection type and access information.
Retrieve detailed information about a specific connected client, including name, IP address, MAC address, connection type and access information.
Authorization
ApiKey UniFi API key. Create one under Control Plane → Admins & Users → your admin → Create API Key (requires controller 9.0.114+).
In: header
Path Parameters
Response Body
application/json
curl -X GET "https://example.com/v1/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "type": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "connectedAt": "2019-08-24T14:15:22Z", "ipAddress": "string", "access": null}Execute Client Action POST
Perform an action on a specific connected client. The request body must include the action name and any applicable input arguments.
List Connected Clients GET
Retrieve a paginated list of all connected clients on a site, including physical devices (computers, smartphones) and active VPN connections. <details> <summary>Filterable properties (click to expand)</summary> |Name|Type|Allowed functions| |-|-|-| |`id`|`UUID`|`eq` `ne` `in` `notIn`| |`type`|`STRING`|`eq` `ne` `in` `notIn`| |`macAddress`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`| |`ipAddress`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`| |`connectedAt`|`TIMESTAMP`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| |`access.type`|`STRING`|`eq` `ne` `in` `notIn`| |`access.authorized`|`BOOLEAN`|`isNull` `isNotNull` `eq` `ne`| </details>