Skip to main content

UniFi

UniFi is Ubiquiti’s network platform: gateways, switches and access points managed from a UniFi console. This connector brings in the UniFi devices you manage, and, if you choose, every device currently connected to them, including computers, phones and IoT devices that no other tool in your environment sees.

Beta. This connector was built from Ubiquiti’s published API specifications and hasn’t been verified against a live account yet. It may return incomplete data or fail in ways we haven’t seen. If something looks wrong, contact [email protected].

At a glance

Data providedDevices
AuthenticationSite Manager API key
Where to configureConnectors → Add a Connector → UniFi

Two options, two sets of permissions

Managed UniFi devicesConnected devices (optional)
What you getYour gateways, switches, access points and consolesComputers, phones, IoT and other devices currently connected, wired or wireless
Always on?YesNo. Off until you tick the box in Navigator
What the key’s account needsOwner or super admin of the consoleAccess to the console’s Network application (a read-only role is enough)
Console requirementNone beyond a UniFi accountUniFi OS firmware 5.0.3 or later, Network application 10.1.84 or later

One API key covers both. It inherits the permissions of the account that created it, and UniFi API keys have no scopes, so the account is the permission boundary. Create the key from a dedicated account used only for Navigator, not a personal one, and don’t use it for anything else.

Ubiquiti’s documentation describes Site Manager API keys as read-only today, and Navigator only ever reads (it sends GET requests and nothing else). That is a property of the key as UniFi issues it today. It isn’t something Navigator can enforce for you, which is another reason to give the account no more access than you need.

Setup

  1. Sign in to unifi.ui.com with the dedicated account. It must be the owner or a super admin of the consoles you want Navigator to see. (Ubiquiti’s device list only returns consoles where the account holds one of those roles.)
  2. If you plan to import connected devices, make sure the account can open the Network application on each of those consoles.
  3. Go to Settings → API Keys and select Create New API Key.
  4. Copy the key. UniFi shows it once.
  5. In Navigator, go to Connectors → Add a Connector → UniFi.
  6. Paste the key into UniFi Site Manager API key.
  7. Tick Also import devices currently connected to your UniFi networks if you want connected devices. Leave it unticked to import only your managed UniFi devices.
  8. Save. Navigator enqueues a first sync immediately. You can change the checkbox later by editing the connector and entering the key again.

Ubiquiti’s references: Site Manager API and Network API.

What data this connector provides

Managed UniFi devices (always):

  • Name, model, MAC address and IP address, with Ubiquiti as the manufacturer.
  • Whether the device is online. An online device counts as active as of the sync.
  • Firmware version, whether it is up to date or an update is available, product line, the console that manages it and when it was adopted. These appear as UniFi: fields on the device page and can be searched.

Connected devices (only if you tick the box):

  • MAC address, IP address and the name the console shows. The name is used as the device’s hostname only when it looks like a hostname; a name with spaces, such as “Living room TV”, or a name that is just a MAC address is kept as UniFi: Name on the console but is never used to match the device to another source.
  • Whether it is wired or wireless, when the current connection started, the site, and the UniFi switch or access point it is connected through.
  • Guest or standard network access.

UniFi reports only what is connected at the moment of the sync, so these devices are shown as active as of that sync. A device that has since left the network disappears from the list.

How connected devices are treated

A connected device shows that something is on your network. UniFi doesn’t manage or secure it, so Navigator treats these records as discovery, never as coverage:

  • They never count as endpoint protection, device management or vulnerability scanner coverage.
  • A device that UniFi is the only source for appears as Network-only: known to be on your network and missing the agents or management you’d expect. That is usually the reason to turn the option on.
  • When the same device is also reported by another connector (for example Intune or Defender), the records are matched by MAC address and the device keeps the other connector’s coverage.

Known limitations

  • Rate and size limits. Connected devices are read through Ubiquiti’s cloud connector, which allows 100 requests a minute per console, 25 seconds per request and 10 MB per response. Navigator pages 200 devices at a time. A very large network syncs slowly rather than failing.
  • Consoles it can’t read. A console that is offline, or where the key’s account has no Network access, is skipped and the sync notes how many. The managed devices and other consoles still sync.
  • VPN and Teleport connections are skipped. They are remote sessions, not devices on the network, and have no MAC address.
  • No serial numbers. UniFi’s APIs don’t return them, so matching to other sources relies on MAC address and hostname.
  • Only what UniFi reports now. There is no history of past connections.
  • Protect and Access aren’t covered. Cameras and door hardware appear in the managed device list when UniFi includes them, but the Protect and Access applications’ own data is not read.
  • Self-hosted controllers. Only consoles registered to your unifi.ui.com account are reachable. A standalone controller with no cloud registration needs the on-premises runner, which isn’t available yet.