It connects to a Unifi Controller, given a url, username and password. Returns an authenticated http Client you may use to query the device for data. Also contains some built-in methods for de-serializing common client and device data. The data is provided in a large struct you can consume in your application.

This library is designed to PULL data FROM the controller. It has no methods that update settings or change things on the controller. Someone expressed interest in adding methods to update data, and I'm okay with that. I'll even help add them. Tell me what you want to do, and we'll make it happen.

Pull requests, feature requests, code reviews and feedback are welcomed!

Here's a working example:

package main

import "log"
import "github.com/unpoller/unifi/v6"

func main() {
	c := *unifi.Config{
		User: "admin",
		Pass: "superSecret1234",
		URL:  "https://127.0.0.1:8443/",
		// Log with log.Printf or make your own interface that accepts (msg, fmt)
		ErrorLog: log.Printf,
		DebugLog: log.Printf,
	}
	uni, err := unifi.NewUnifi(c)
	if err != nil {
		log.Fatalln("Error:", err)
	}

	sites, err := uni.GetSites()
	if err != nil {
		log.Fatalln("Error:", err)
	}
	clients, err := uni.GetClients(sites)
	if err != nil {
		log.Fatalln("Error:", err)
	}
	devices, err := uni.GetDevices(sites)
	if err != nil {
		log.Fatalln("Error:", err)
	}

	log.Println(len(sites), "Unifi Sites Found: ", sites)
	log.Println(len(clients), "Clients connected:")
	for i, client := range clients {
		log.Println(i+1, client.ID, client.Hostname, client.IP, client.Name, client.LastSeen)
	}

	log.Println(len(devices.USWs), "Unifi Switches Found")
	log.Println(len(devices.USGs), "Unifi Gateways Found")

	log.Println(len(devices.UAPs), "Unifi Wireless APs Found:")
	for i, uap := range devices.UAPs {
		log.Println(i+1, uap.Name, uap.IP)
	}
}

GetConsoleSystem() reads /api/system using the existing local console session. This console-wide endpoint returns broader system information independently of Network sites. The current ConsoleSystem model exposes only the verified devices.unifiOS[] firmware fields from a UCG Fiber response; other fields are ignored. Additional typed sections can be added as representative responses and their meanings are validated. GetJSON(APIConsoleSystemPath) provides access to the full JSON response when fields are not yet modeled.

The endpoint is a private UniFi OS API; it may be absent or forbidden for some controllers/accounts. Community UNAS and gateway references describe broader identity, hardware, uptime and application data, and responses that vary with authentication. These are compatibility references, not a complete vendor schema or a claim of support for those fields. API-key and remote access have not been validated by this implementation.

Valid partial JSON objects are accepted even when devices.unifiOS is absent, null or empty. Callers must check for firmware entries before using them; missing data does not mean no update. A JSON null response, malformed data, and request failures still return errors. This information is separate from GetSysinfo() and the Network application's update flags.

ConsoleFirmware.UpdateStatus() returns (available, known). An offered version or firmwareStatus: "updateAvailable" means an update is available; "upToDate" without an offered version means no update. Missing/null versions alone and unrecognized firmware states are unknown. Callers should omit unknown readings, and handle collection errors without treating them as a no-update result.

The main CLI (in main/) supports a discover mode that probes known API endpoints on your controller and writes a shareable report. Use the same credentials you use with unpoller (from your config file or env).

With a config file (JSON with url, user, pass; optional api_key):

go run ./main --discover --config /path/to/unifi-config.json --output api_endpoints_discovery.md

With environment variables (same as unpoller: GOLIFT_UNIFI_URL, GOLIFT_UNIFI_USER, GOLIFT_UNIFI_PASS):

export GOLIFT_UNIFI_URL=https://192.168.1.1:8443
export GOLIFT_UNIFI_USER=admin
export GOLIFT_UNIFI_PASS=yourpassword
go run ./main --discover --output api_endpoints_discovery.md

The report lists each endpoint and its HTTP status (200, 404, etc.). Share the generated file with maintainers when reporting API or 404 issues (e.g. unpoller#935).