Files
homepage/docs/widgets/services/unifi-controller.md
shamoon a7fe80a399
Some checks failed
Docker CI / Linting Checks (push) Has been cancelled
Docker CI / Docker Build & Push (push) Has been cancelled
Docs / Linting Checks (push) Has been cancelled
Docs / Test Build Docs (push) Has been cancelled
Docs / Build & Deploy Docs (push) Has been cancelled
Tests / vitest (3) (push) Has been cancelled
Tests / vitest (4) (push) Has been cancelled
Tests / vitest (1) (push) Has been cancelled
Tests / vitest (2) (push) Has been cancelled
Crowdin Action / Crowdin Sync (push) Has been cancelled
Documentation: fix UniFi admonitions
2026-03-28 21:05:28 -07:00

1.1 KiB

title, description
title description
Unifi Controller Unifi Controller Widget Configuration

Learn more about Unifi Controller.

(Find the Unifi Controller information widget here)

You can display general connectivity status from your Unifi (Network) Controller.

!!! warning

When authenticating you will want to use a local account that has at least read privileges.

An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.

Allowed fields: ["uptime", "wan", "lan", "lan_users", "lan_devices", "wlan", "wlan_users", "wlan_devices"] (maximum of four). Fields unsupported by the unifi device will not be shown.

!!! tip

If you enter e.g. incorrect credentials and receive an "API Error", you may need to recreate the container or restart the service to clear the cache.
widget:
  type: unifi
  url: https://unifi.host.or.ip:port
  site: Site Name # optional
  username: user
  password: pass
  key: unifiapikey # required if using API key instead of username/password