unifi-operator
Installation
SKILL.md
UniFi Operator
Operate a UniFi OS console (UDM, UDM-Pro/SE, UDR, UCG, Cloud Key Gen2+, or self-hosted Network/Protect) over HTTP. Two product apps, each with a stable official API and a comprehensive private API:
- Network — gateways, switches, APs, clients, VLANs, WLANs, firewall, routing, port-forwards, DPI, guest/hotspot, device adoption & lifecycle.
- Protect — cameras, recordings, snapshots, smart-detection events, lights, sensors, chimes, sirens, viewers, alarm manager, realtime updates.
All four surfaces live on one console at port 443 behind a self-signed TLS cert (every curl uses -k). Cloud Site Manager (api.ui.com) is out of scope — this skill is local-console only.
API surface map
| Surface | Base path | Auth | Stability | Coverage |
|---|---|---|---|---|
| Network — official | /proxy/network/integration/v1 |
X-API-KEY header (stateless) |
GA, stable | ~60% — sites, devices, clients, vouchers, networks, WLANs, firewall, ACL, DNS |
| Network — private | /proxy/network/api/s/<site> |
Cookie TOKEN + x-csrf-token |
Unsupported, shifts across versions | ~100% — everything the web UI does (stats, rest/* CRUD, cmd/* actions) |
| Protect — official | /proxy/protect/integration/v1 |
X-API-KEY header (stateless) |
GA, stable (Protect 5.3+) | ~70% — cameras, snapshot, RTSPS, PTZ, lights/sensors/chimes, arm profiles, WS |
| Protect — private | /proxy/protect/api |
Cookie TOKEN + X-CSRF-Token |
Unsupported, shifts across versions | ~100% — /bootstrap, video export, events/thumbnails, realtime delta WebSocket |
Pick the official surface first (stateless API key, survives upgrades). Drop to the private surface for anything official omits: firewall/WLAN CRUD on older firmware, client block/unblock, device adopt/locate/speedtest, full Protect bootstrap, recorded-video export, and the realtime updates socket.