Beta adapter

Ubiquiti UniFi

Read UniFi sites, devices, clients, networks, and WLANs and run dual-gated writes (port profile, PoE, WLAN PSK, client block) through one API. Beta: test-verified, field reports welcome.

See it in the demoAdapter docs
Vendor: UbiquitiCategory: NetworkingBeta

Beta: gold-standard contract verified by 136 tests, but not yet run against real Ubiquiti hardware.

The UniFi adapter manages Ubiquiti UniFi controller-managed switches, access points, and security gateways. It supports both the classic UniFi Network Application and UniFi OS consoles (UDM, UDM-Pro, Cloud Key Gen2+), auto-detecting the auth mode at init. It is Beta: the gold-standard contract is enforced and verified by 136 passing tests, but the maintainer has not yet run it against physical Ubiquiti gear.

What you can do

Ubiquiti UniFi capabilities

Classic and UniFi OS, auto-detected

Works against the classic Network Application on port 8443 and modern UniFi OS consoles (UDM, UDM-Pro, Cloud Key Gen2+) behind the network proxy, picking the right auth flow automatically.

Dual-gated, audit-logged writes

Every write requires read-only mode off and a per-call force flag, requires site-admin, and emits a structured audit line. WLAN PSKs are never logged.

Honest Beta posture

The adapter passes 136 tests against the API contract but has not been exercised on real Ubiquiti hardware. We label it Beta on that basis and welcome field reports through GitHub Issues.

19 read methods, all redacting secrets on returnSites and site health, devices and port overridesClients, networks (VLANs, subnets, DHCP scopes), and WLANs (PSK stripped on read)Firewall rules and groups, port forwards, RADIUS and VPN clientsController info, sysinfo, and alerts9 dual-gated writes: device restart, port-override profile, per-port PoE mode, WLAN PSK rotation, WLAN enable/disable, client block / unblock / forget, device disableAuto-detects classic Network Application vs UniFi OS console auth
How it connects
  • Connects to the UniFi Network Application (classic, port 8443) or a UniFi OS console.
  • Authenticates with a controller username and password stored as an encrypted credential.
  • No dedicated UI yet: operators consume the REST endpoints directly (a UniFi UI is on the roadmap).
Tier
Beta (test-verified)
Category
Networking
Transport
UniFi Network / UniFi OS REST
Auth
Controller username + password (auto-detect)
Reads / Writes
19 reads, 9 dual-gated writes
UI
REST only (UI on roadmap)
Good to know
  • No frontend UI yet; operators call the REST endpoints directly.
  • Network CRUD is read-only for now (VLANs and DHCP scopes are not writable).
  • Captive-portal / hotspot writes, the topology endpoint, SDN backup/restore, and L2/L3 adoption flows are not yet wired.
  • Not yet validated against physical Ubiquiti hardware.
Powers these modules
Network Management
Adapter reference docs →Open the live demo →

Explore other integrations

All adapters →
TP-Link OmadaTP-Link · NetworkingProductionMikroTik RouterOSMikroTik · NetworkingProductionOpenWrtOpenWrt · NetworkingPreviewOPNsenseDeciso · FirewallProductionpfSenseNetgate · FirewallPreviewHikvisionHikvision · CamerasProductionONVIFONVIF · CamerasPreviewFreePBXSangoma · VoIPBetaGrandstreamGrandstream · VoIPBetaProxmox VEProxmox · ComputeProductionTrueNASiXsystems · StoragePreview

See it running in your browser

Explore the full FreeSDN dashboard with realistic sample data, no signup, no backend. Then install it in minutes.

Live DemoRead the DocsView on GitHub →