Connect Ubiquiti UniFi to ScalePad 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?
|
|
What you'll need:
|
| Note: You can use this integration if you host your UniFi consoles with HostiFi, as long as the consoles appear in UniFi Site Manager. For details, see HostiFi’s UniFi OS Server API documentation. |
Step 1: Generate a UniFi API key
For more information, see Getting Started with the Official UniFi API.
- Sign in to the UniFi Site Manager.
- Open Settings.
- Select API Keys.
- Select Create New API Key.
- Select the applicable sites and grant the required Site Manager and Network access.
- Create the API key.
- 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 ScalePad
- Log in to the ScalePad Hub and click Integrations.
- Click + Add Integration.
- Search for UniFi Network and choose the UniFi Network tile.
- Enter your UniFi API key.
- Click Connect now.
- Confirm that the connection succeeds.
- Click Save and sync now.
Your UniFi network devices will be available in ScalePad after synchronization completes.
Step 3: Map consoles and Network sites to clients
If Map clients and site mapping are available for your connection, review the discovered consoles and Network sites before syncing. Availability depends on the mapping features enabled for your account.
- Open the UniFi connection in Integration Center and select Map clients. Run discovery and wait for it to finish.
- Review the console and site rows in Needs review. Choose an existing ScalePad client, create a new client, or choose Don’t sync for each row you want to decide.
- Use the row’s Accept action or accept the reviewed selection. Edited or suggested choices do not take effect until accepted.
- Confirm accepted links in Mapped and exclusions in Don’t sync, then run the integration sync.
An accepted site mapping takes precedence over its console mapping for that site’s devices. Accepting Don’t sync for a site excludes its devices even if the console is mapped. A site without an accepted decision inherits its included console’s client mapping. Connections without site mapping continue to use console assignment.
Review exclusions carefully: accepting Don’t sync removes that connection’s association, and data supplied only by it can be removed during sync cleanup. If Map clients or the expected sites are unavailable, check API-key access and contact ScalePad Support rather than creating a duplicate connection. See Client Mapping for the complete review and acceptance workflow.
Fields we are syncing data for
| UniFi object | UniFi field | ScalePad 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?
ScalePad syncs supported UniFi network hardware, including:
- Gateways and consoles
- Switches
- Access points
- Other network devices that do not match a more specific device classification
How syncing works
- Initial sync: ScalePad validates the API key and retrieves UniFi device data from UniFi Site Manager.
- Ongoing sync: ScalePad retrieves the current device inventory when the integration synchronization runs.
- Matching: Devices are matched primarily by the UniFi device ID.
- Device names: ScalePad 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, ScalePad uses the UniFi device ID.
- Direction: Data flows one way from UniFi Network to ScalePad.
- 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
- Getting Started with the Official UniFi API
- UniFi Network API documentation
- UniFi Site Manager
- Contact ScalePad Support
| Any questions? Reach out to our ScalePad support team by submitting a support ticket. |
 NEW 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. |
Related to
