Integrating with Ubiquiti UniFi

Ishita Snehil
Ishita Snehil
  • Updated

Connect Ubiquiti UniFi to Lifecycle Manager to sync Ubiquiti network devices into your client hardware inventory. The integration is read-only and supports device data from UniFi Site Manager.

Who can use this feature?

  • A Lifecycle Manager account with permission to manage integrations or Manage Sync permissions.

What you'll need

  • A UniFi Site Manager account with access to the sites you want to sync.
  • Permission to create API keys in UniFi Site Manager.
  • A UniFi API key with access to Site Manager and Network data for the applicable sites.

What you'll need:
 

  • A UniFi Site Manager account with access to the sites you want to sync.
  • Permission to create API keys in UniFi Site Manager.
  • A UniFi API key with access to Site Manager and Network data for the applicable sites.

Step 1: Generate a UniFi API key

For more information, see Getting Started with the Official UniFi API.

  1. Sign in to the UniFi Site Manager.
  2. Open Settings.
  3. Select API Keys.
  4. Select Create New API Key.
  5. Select the applicable sites and grant the required Site Manager and Network access.
  6. Create the API key.
  7. Copy the key and store it in an approved password manager.

UniFi displays the API key only once. If you lose it, create a replacement key and update the integration.

Step 2: Connect UniFi Network to Lifecycle Manager

  1. Log in to the ScalePad Hub and click Integrations.
  2. Click + Add Integration.
  3. Search for UniFi Network and choose the UniFi Network tile.
  4. Enter your UniFi API key.
  5. Click Connect now.
  6. Confirm that the connection succeeds.
  7. Click Save and sync now.

Your UniFi network devices will be available in Lifecycle Manager after synchronization completes.

Fields we are syncing data for

UniFi object UniFi field Lifecycle Manager field
Device id Device identifier
Device name Asset name
Device model Model
Device mac Serial number and MAC address
Device ip IP address
Device adoptionTime Purchase date
Device shortname, model, isConsole Device type
Device group hostId, hostName Console or company context

What syncs from UniFi Network?

Lifecycle Manager syncs supported UniFi network hardware, including:

  • Gateways and consoles
  • Switches
  • Access points
  • Other network devices that do not match a more specific device classification

The integration does not currently sync:

  • UniFi Protect cameras
  • UniFi Access or InnerSpace devices
  • Connected client devices
  • Port configuration
  • Firmware-update status
  • Network configuration
  • Security policies or alerts

How syncing works

  • Initial sync: Lifecycle Manager validates the API key and retrieves UniFi device data from UniFi Site Manager.
  • Ongoing sync: Lifecycle Manager retrieves the current device inventory when the integration synchronization runs.
  • Matching: Devices are matched primarily by the UniFi device ID.
  • Device names: Lifecycle Manager uses the UniFi device name when available.
  • Serial numbers: The MAC address is used as the serial-number value. If no MAC address is available, Lifecycle Manager uses the UniFi device ID.
  • Direction: Data flows one way from UniFi Network to Lifecycle Manager.
  • API access: The integration uses read-only requests to the UniFi Site Manager API.
  • Pagination: Large device inventories are retrieved across multiple pages..

Troubleshooting

Symptom Likely cause Resolution
The connection fails The API key is invalid, revoked, or lacks access to the required sites Create or verify the UniFi API key and reconnect the integration
No devices appear The API key cannot access the applicable sites, or the sites contain no supported UniFi devices Review the API-key site access and confirm that supported devices are present
Some devices are missing The devices are outside the API-key scope or are not supported by the integration Update the key scope and confirm whether the missing devices are UniFi Network devices
A device has an unexpected type The model does not match a known UniFi classification pattern Review the device model and contact ScalePad Support if the classification is incorrect
The purchase date is unexpected UniFi provides the device adoption time rather than the original purchase date Use the purchase date as an approximate deployment date
The API request is rate limited UniFi has temporarily limited API requests Wait and run the synchronization again
Devices are not updated immediately The latest synchronization has not completed Run another synchronization and verify the integration status

Related resources

Any questions? Reach out to our Lifecycle Manager support team by submitting a support ticket.
:sparkles: NEW :sparkles: Join our MSP Power-Ups - Free 15-minute micro-workshops + live Q&A with our Lifecycle Manager experts. Sign up here to reserve your spot.

Was this article helpful?

Yes! No