Site Manager API

Getting Started

List Hosts

Retrieve a list of all hosts associated with the UI account making the API call.

Note: The structure of userData and reportedState may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.0.6.

Get Host by ID

Retrieve detailed information about a specific host by ID.

Note: The structure of userData and reportedState may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.0.6.

List Sites

Retrieve a list of all sites associated with the UI account making the API call.

Note: The structure of meta and statistics may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.0.6.

List Devices

Retrieve a list of UniFi devices managed by hosts where the UI account making the API call is the owner or a super admin.

Note: The structure of devices.uidb may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.0.6.

Get ISP Metrics

Retrieve ISP metrics data for all sites linked to the UI account’s API key. 5-minute metrics are available for at least 24 hours, and 1-hour metrics for at least 30 days.

Query ISP Metrics

Retrieve ISP metrics data based on specific query parameters. 5-minute metrics are available for at least 24 hours, and 1-hour metrics for at least 30 days.

Note: If the UI account lacks access to all requested sites, a 502 error is returned. If partial access is granted, the response will include status: partialSuccess.