Migrate to new Network Application API

[michaelolson]

The UniFi Network Application 9.0.108 release introduced the Network Application API, which seems to be the supported path forward for API access to the controller.

I would expect long term integrations will want to be moving towards the new officially supported API instead of relying on the previously observed internals, at least once feature parity is reached. The Getting Started with the Official UniFi API page provides a link on where to find the API docs. The API docs are, interestingly, not hosted in an obvious location online, but instead local to the controller:

To access the localized Network API documentation (specific to your UniFi Network version), navigate to UniFi Network > Settings > Control Plane > Integrations. This includes a variety of capabilities including:

• UniFi devices (e.g., access points, switches, and gateways)
• Client activity (e.g., connected devices, usage statistics)
• Traffic insights (e.g., bandwidth consumption, network trends)

Parity with the existing internal access is an open question, but much of the needed data on clients is available through the API already. The API relies on API keys instead of usernames and passwords, which is an interesting delta that might make some of these integrations simpler. Each API key is bound to the user who created it, so provisioning an appropriately permissioned user is still important.

[joshuaspence]

Thanks, this is being tracked in paultyng/go-unifi#240

[michaelolson]

Thanks for the redirect!