Unifi Network Sync

Description

This article guides tenant administrators through installing and configuring the Equiviq UniFi Network Sync plugin, connecting it to their UniFi environment, and setting up synchronization of network data with Equiviq.

Prerequisites

• User must have Tenant administrator roles.

Obtaining a Ubiquiti API key

1. Login to the Ubiquiti portal at https://unifi.ui.com with an account that can generate API keys.
2. On the left navigation menu, click the settings icons.
3. In the submenu, click API keys.
4. Click Create New API Key.
5. In the name field, type a *name for this key *(ex: Equiviq Sync).
6. In the expiration field, *select the expiration duration *of the API key.
7. The API key will need the following access rights: Site Manager, UniFi Applications (Network, Protect and All Sites)
8. Click Create.

IMPORTANT

Once the API is created, it is only displayed once and never again.

Unifi Sync Configuration

1. Upload the Equiviq-Unifi-Sync plugin to the Tenant Plugins menu.
2. Click Enable
3. Click Settings
4. Enter the API Key