UniFi
UniFi network and camera observability, and the captive-portal controls, for hospitality properties.
partRunning the shop16 operationsid unifi
How it sits
A part does one thing, and any other part can call it. The counts and the links below are from the platform's spec and the other services' own descriptions.
| Operations | 16 GET 12 · POST 3 · DELETE 1 |
| Resources | 7 |
| Leaned on by | Captive portal |
| Leans on | none named |
| In recipes | none yet |
What it can do
16 operations in 7 resources, as the spec declares them. Each row is one call; paths are relative to the part.
sites
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/sites | List UniFi sites |
| GET | /api/v1/sites/{site_id}/clients | List clients on a site |
| GET | /api/v1/sites/{site_id}/devices | List devices on a site |
| GET | /api/v1/sites/{site_id}/guests/{mac} | Pending-guest lookup by MAC |
| POST | /api/v1/sites/{site_id}/guests/{mac}/authorize | Authorize a guest MAC (Captive portal portal) |
| POST | /api/v1/sites/{site_id}/guests/{mac}/unauthorize | Unauthorize a guest MAC (abuse/admin path) |
| GET | /api/v1/sites/{site_id}/vouchers | List hotspot vouchers |
| POST | /api/v1/sites/{site_id}/vouchers | Generate hotspot vouchers |
| DELETE | /api/v1/sites/{site_id}/vouchers/{voucher_id} | Revoke a voucher |
9 operations
health
| Method | Path | Does |
|---|---|---|
| GET | /health | Basic health check |
| GET | /health/detailed | Detailed health check |
2 operations
config
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/config | UniFi wiring status |
1 operation
controller
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/controller/health | Controller reachability over the tunnel |
1 operation
prime
| Method | Path | Does |
|---|---|---|
| GET | /prime | Prime application caches |
1 operation
protect
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/protect/cameras | List UniFi Protect cameras |
1 operation
status
| Method | Path | Does |
|---|---|---|
| GET | /status | Service status overview |
1 operation
All the partsRunning the shopThe platform's own id for this service is cbunifi.
forge-catalog.json, generated Oct 30, 2026