Site Manager API v1.0 (Official)

Getting Started

A comprehensive guide for unifi.ui.com (Site Manager) users to utilize the API effectively

Response Format

Explore the standardized JSON response format for UniFi Site Manager API, including success and error response structures, common error codes, and best practices for error handling

Version Control

Learn about UniFi Site Manager API versioning policy, including version lifecycle, deprecation guidelines, and best practices for API version management

List Hosts

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

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

Get Host by ID

Retrieves detailed information about a specific host by ID.

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

List Sites

Retrieves a list of all sites (from hosts running the UniFi Network application) associated with the UI account making the API call.

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

List Devices

Retrieves 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 the devices.uidb field may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.1.13.

Get ISP Metrics

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

Query ISP Metrics

Retrieves ISP metrics data based on specific query parameters. 5-minute interval metrics are available for at least 24 hours, and 1-hour interval metrics are available 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.

List SD-WAN Configs

Retrieves a list of all SD-WAN configurations associated with the UI account making the API call.

Get SD-WAN Config by ID

Retrieves detailed information about a specific SD-WAN configuration by ID.

Get SD-WAN Config Status

Retrieves the status of a specific SD-WAN configuration, including deployment progress, errors, and associated hubs.