If you need to use APIs with UniFi OS Server, then there are three ways this can be completed. All three of these work with HostiFi.

API Changes (UniFi Network Server vs UniFi OS Server)

If you are moving from the legacy UniFi Network Server to UniFi OS Server, then some things get changed that might cause issues with existing APIs.

Unofficial UniFi API

This is the most flexible option available. It essentially allows anything to be possible and actually reverse engineers the API that the Chrome inspector uses.

Here is one example of a PHP implementation but you can make your own.

Official UniFi OS Server API

Ubiquiti provides its own API service, and can be used within UniFi OS Server itself. An API key can be created to be used with various applications, but at the moment it is fairly limited, but Ubiquiti is rolling out updates to it on a regular basis.

Ubiquiti also provides its own documentation for this.

Site Manager API

The Site Manager API does require a Ubiquiti SSO account and utliises the unifi.ui.com dashboard. This is more limited than the Official UniFi OS Server API, but it can be used without opening any ports.

Ubiquiti also provides its own documentation for this.

Migrating an Existing Application

If you already have an application using the older UniFi API, you generally do not need to rewrite the entire application.

The main changes are:

• Update the authentication/login process.
• Update the base URL used for API requests.

Your existing application logic and most of your API calls can remain largely unchanged.

If you have custom code that needs to be migrated, use the migration information above as a guide to update authentication and request URLs rather than rebuilding the application from scratch.