Skip to main content
The UniFi Console integration connects your Ubiquiti UniFi environment to MSPortal so network hardware appears alongside the rest of your managed devices.

​
Overview

UniFi is treated as an RMM-style device source. Once connected, MSPortal syncs:
  • Sites from the UniFi console, which you map to MSPortal companies
  • Devices (access points, switches, gateways, cameras) into a staging area, ready to import into your device inventory
  • Networks (VLAN, LAN, and WAN configurations) for self-hosted controllers
UniFi is set up through the standard integration wizard with three steps: Connect, Map, and Import. Each console is added as its own connection, and you can connect as many consoles as you need.
The UniFi integration is in early access and is hidden until it is enabled for your tenant. If you do not see the UniFi card under Settings > Integrations, contact support@msportal.ai to have it turned on.

​
Connection models

You can add as many UniFi connections as you need, and mix the models freely.

Global console

One UniFi console that spans all of your clients. Sites are mapped to companies manually after the first sync.

Per-company console

A console that belongs to a single client. Every site it discovers is automatically linked to that company.

UniFi Cloud

Connects through Ubiquiti’s Site Manager API using an API key from your ui.com account.

Self-hosted controller

Connects directly to a UniFi OS controller or Cloud Key on your network, using an API key or a username and password.

​
Prerequisites

Before you begin, make sure you have:
  • The UniFi integration enabled for your tenant (see the note above)
  • Administrative access to your UniFi Cloud account or self-hosted controller
  • MSPortal integration management permissions
  • Companies already created in MSPortal, so you have something to map sites to

​
Part 1: Get Your UniFi Credentials

Choose the method that matches how you access UniFi.
1

Sign in to UniFi Site Manager

Go to unifi.ui.com and sign in with the Ubiquiti account that owns the consoles you want to sync.
2

Create an API key

Open the API section and create a new API key. Copy it immediately, it is only shown once.
The cloud API key covers every console and site under that Ubiquiti account, which makes it a good fit for a single global connection. It is read-only, and it does not expose network (VLAN) configurations.
MSPortal needs to reach your controller over the network. A controller that is only reachable on a private LAN, with no port forward, VPN, or reverse proxy, cannot be synced. In that case, use a UniFi Cloud connection instead.

​
Part 2: Connect a Console in MSPortal

1

Start the setup wizard

Go to Settings > Integrations, find UniFi Console, and click Connect. If you already have a UniFi connection and want to add another console, click Connect another on the UniFi Console row instead.
2

Fill in the connection details

3

Test the connection

Click Test Connection. A “Connected to UniFi successfully” message confirms MSPortal can reach the console and authenticate.
4

Create the integration

Click Create Integration. MSPortal stores the credentials securely, starts the first sync, and the wizard moves on to the Map step.
Credentials are encrypted in secure vault storage. They are never shown again after saving, and never appear in logs. When you reopen the wizard later, leaving a credential field masked or empty keeps the existing value.

​
Part 3: Map Sites to Companies

A UniFi site is the unit that maps to an MSPortal company. Devices and networks inherit the company from their site.
Nothing to do. Every site discovered by a per-company connection is linked to that company automatically at sync time.

​
Part 4: Import Devices

1

Open Device Import

On the wizard’s Import step, click Open Device Import. You can also reach this page anytime using the Import Devices action on the UniFi row under Settings > Integrations.
2

Map device types

In the Device Type Mappings table, map each discovered UniFi device type (access points, switches, gateways, cameras) to an MSPortal device type. Use Ignore for types you do not want in your inventory.
3

Enable Auto-Sync (optional)

Check Auto-Sync on a mapped device type, or use Enable All Auto-Sync, to automatically import new devices of that type after each sync.
4

Import staged devices

The Staged Devices list shows each discovered device with its name, model, type, MAC address, IP address, firmware, status, site, and company. Select the devices you want and click Import Selected. They are created in your device inventory with UniFi as the source and Ubiquiti as the manufacturer, and they appear in the Devices module, reports, and compliance alongside devices from your RMM.
Auto-Sync replaces manual importing. Once a device type has Auto-Sync enabled, new devices found on mapped sites are imported automatically after each sync.

​
What Gets Synced

Network configurations are only available from a self-hosted controller using username and password. The UniFi Cloud API and the controller API key method do not expose them, so no network data is synced for those connections.
MSPortal only reads from UniFi. It never changes your UniFi configuration, adopts devices, or modifies networks.

​
Sync Schedule

Each connection shows its own last sync time on the integrations list.

​
Managing Connections

Each UniFi connection appears as its own row under Settings > Integrations. From the row you can:
  • Configure: reopen the setup wizard to change connection settings, credentials, sync toggles, or site mappings. On the Connect step, click Save connection to apply changes
  • Resync: pull the latest sites, devices, and networks from that console
  • Import Devices: open the device import page for that console
  • Rename: give the connection a nickname to tell it apart from other consoles
  • Disconnect: remove the connection and its stored credentials
Disconnecting removes the stored credentials and the synced UniFi data for that connection, and cannot be undone. Devices you already imported into your inventory are kept.

​
Troubleshooting

The integration is in early access and is enabled per tenant. Contact support@msportal.ai to have it turned on for your account.
Causes:
  • The controller URL is wrong, or is missing the port (for example :8443)
  • The controller uses a self-signed certificate
  • MSPortal cannot reach the controller from the internet
  • API key authentication was used on a controller older than UniFi OS 9.x
Solutions:
  1. Confirm the URL by opening it in a browser from outside your network
  2. Turn on Allow self-signed certificate
  3. Publish the controller through a VPN, reverse proxy, or port forward, or switch to a UniFi Cloud connection
  4. On older controllers, switch the authentication method to Username & password
Causes:
  • The API key was copied incorrectly, or has been revoked
  • The key belongs to a different Ubiquiti account than the consoles you expect
Solutions:
  1. Generate a new API key at unifi.ui.com and paste it again
  2. Confirm the account that created the key owns the consoles you want to sync
Causes:
  • The first sync has not finished yet
  • The credentials only have access to consoles with no sites
Solutions:
  1. The Map step checks for new sites automatically. Give it a few minutes, or use the sync button on the step to trigger a fresh sync
  2. Confirm the account or API key can see the sites in UniFi itself
Devices inherit their company from their site. Click Configure on the UniFi connection, open the Map step, map the site to a company, then sync again.
Network configurations are only returned by a self-hosted controller using Username & password authentication. UniFi Cloud and controller API keys do not expose them. Check also that Sync networks is enabled on the connection.

​
Best Practices

Name every connection

With several consoles in play, a connection name like “Acme HQ Cloud Key” is far easier to work with than a scope label.

Map sites before importing

Devices on unmapped sites have no company and cannot be imported. Finish the Map step first.

Use per-company connections where you can

Sites link to the company automatically, which removes the mapping step entirely.

Turn on Auto-Sync for network gear

Access points and switches rarely need review before import, so Auto-Sync on those device types keeps the inventory current with no manual work.

​
Need Help?

For assistance with the UniFi integration, contact support@msportal.ai.