https://github.com/unpoller/unifi
Go Library (w/ structures) to grab data from a Ubiquiti UniFi Controller
https://github.com/unpoller/unifi
go-modules go-unifi unifi-api unifi-controller unifi-poller
Last synced: about 1 month ago
JSON representation
Go Library (w/ structures) to grab data from a Ubiquiti UniFi Controller
- Host: GitHub
- URL: https://github.com/unpoller/unifi
- Owner: unpoller
- License: mit
- Created: 2019-01-24T02:10:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2026-03-24T01:55:10.000Z (3 months ago)
- Last Synced: 2026-03-24T22:14:27.945Z (3 months ago)
- Topics: go-modules, go-unifi, unifi-api, unifi-controller, unifi-poller
- Language: Go
- Homepage: https://golift.io/discord
- Size: 743 KB
- Stars: 143
- Watchers: 11
- Forks: 32
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-unifi - unpoller/unifi - Go library to grab data from a Ubiquiti UniFi Controller (companion library used by UnPoller). (API Libraries / Go)
README
# Go Library: `unifi`
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](https://github.com/unpoller/unifi/issues/31) 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](https://github.com/unpoller/unifi/issues/new), and we'll make it happen.
Pull requests, feature requests, code reviews and feedback are welcomed!
Here's a working example:
```golang
package main
import "log"
import "github.com/unpoller/unifi/v5"
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)
}
}
```
## Endpoint discovery (`--discover`)
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`):
```bash
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`):
```bash
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](https://github.com/unpoller/unpoller/issues/935)).