unifi-api

UniFi API Skill

Interact with a UniFi Dream Router or other UniFi OS console via its REST API. Tested against UDR-7 running UniFi OS 4.x / Network Application 10.x.

CLI (restish) — Preferred for Integration API

A unifi CLI wrapper is installed at ~/.local/bin/unifi. It uses restish with the official OpenAPI spec and injects the API key from 1Password automatically via op run.

# List devices
unifi get-adopted-device-overview-page default

# List connected clients
unifi get-connected-client-overview-page default

# List networks
unifi get-networks-overview-page default

# Get specific network details
unifi get-network-details <networkId> default

# List firewall policies
unifi get-firewall-policies default

# JSON output
unifi get-connected-client-overview-page default --rsh-output-format json

# Filter results (restish shorthand query)
unifi get-connected-client-overview-page default -f 'data[].{name, ipAddress, type}'

Use default as the site ID shorthand — the wrapper replaces it with the real UUID. Override with UNIFI_SITE=<uuid> unifi ... for other sites.

Run unifi --help for the full list of generated commands (44 total, covering devices, clients, networks, firewall, DNS, WiFi, hotspot, ACLs, and more).

Restish configuration

• Config: ~/Library/Application Support/restish/apis.json
• Spec file: ~/Library/Application Support/restish/specs/network-10.2.105.json (patched: server URL set to /proxy/network/integration for UDR proxy path)
• Auth: X-API-Key header, injected via UNIFI_API_KEY env var
• Wrapper: ~/.local/bin/unifi — handles op run, TLS skip, WARN suppression, and default → UUID replacement

Recreating the restish setup from scratch

If restish or the unifi wrapper aren't installed, follow these steps to set them up.

1. Install restish:

brew install restish

2. Download the OpenAPI spec from Ubiquiti:

Go to https://developer.ui.com/ and download the Network API spec for your controller version (JSON format). Save it to the restish specs directory: