Guides
Task-oriented recipes for go-unifi — surfaces, pagination, sites, networks, devices, firewall, and more.
Each guide takes one task — pick a surface, page through results, manage a resource — and walks it end-to-end: a runnable snippet, what it does and why, then the gotchas worth knowing. New here? Start with Choosing a surface, then jump to whatever you need.
Core concepts
Choosing a surface
Internal vs Official: what each is, how to reach them, and the capability gate.
Using the Official API
The fluent per-group surface, uniform method shapes, and site UUIDs.
Pagination & filtering
Bounded pages, lazy streaming, and the Official filter expressions.
Sites
List sites on both surfaces and bridge the site-name vs UUID gap.
Resources
Networks
Create, read, update and delete networks and VLANs.
Devices
Adopt, configure and act on UniFi devices.
Clients & users
Work with connected clients and known users.
Firewall
Zone-based firewall policies, zones and rule ordering.
Wireless
WLANs and wireless settings.
Settings
Read and write site-level settings.
Going further
Feature flags
Check controller capabilities before you call them.
File uploads
Upload files to endpoints that accept them.
Traffic flows
Query traffic rules and flow data.
Error handling
Sentinels, server errors, and how to react to them.
Testing
Mock the client and the Official per-group interfaces in tests.