• An administrator account with access to UniFi Site Manager https://unifi.ui.com.

• Access to the Auvik tenant or site where the credential will be added.

• An API key with the Site Manager scope enabled.

• Under UniFi Applications, the Network and Protect applications selected.

• Console firmware version must be greater than 5.1

UniFi API keys allow Auvik to securely access UniFi Cloud information.

1. Log in to unifi.ui.com https://unifi.ui.com.

2. Select Settings from the lower-left navigation menu.

   

3. Select API Keys.

   

4. Click Create New API Key.

   

5. Enter a descriptive name, such as Auvik Integration.

6. Select an expiration period. You can select Never expires, subject to your organization's security policy.

7. Enable Site Manager.

8. Enable UniFi Applications, then select Network and Protect. Select All Sites or the specific sites that Auvik should access.

9. Click Create or Generate.

10. Copy the API key and store it securely. The complete key may not be displayed again after the creation window is closed.

Protect the API key as you would any other credential. Do not share it in tickets, chat messages, or unsecured documents.

1. Log in to the Auvik platform.

2. Select the appropriate tenant or site.

3. Go to Admin > Discovery > Manage Credentials.

4. Select the API Credentials tab.

5. Click Add API Credentials.

6. Select Ubiquiti UniFi from the credential type list.

   

7. Complete the credential fields:

   • Type: Ubiquiti UniFi API.

   • Name: Enter a descriptive name, such as UniFi Cloud API - Main.

   • API Key: Paste the key generated in UniFi.

   • Auvik Collector: Select the designated collector.

   • Ubiquiti UniFi Host URL: Use api.ui.com unless instructed otherwise.

8. Click Test Connection.

9. After the connection test succeeds, click Save.

The credentials must pass the connection test before they can be saved. After saving, Auvik can begin discovering the UniFi sites and applications permitted by the API key.

Mapping Unifi Sites across multiple Auvik sites

When one Unifi dashboard contains networks belonging to multiple Auvik sites, configure the API credentials once at the appropriate scope and map each Meraki network to the correct Auvik site.

Before saving the configuration, confirm:

• Each Site network is mapped to the intended Auvik site.

• The selected collector can reach the networks and devices that Auvik must discover.

• The collector has the required routing, firewall, and protocol access.

To map to child sites:

1. Select the integration’s name

   

2. Then edit the site you want mapped to an Auvik site

   

3. Then map the child site in Auvik, to the site listed at unifi.ui.com

   

4. Repeat through all Auvik Sites.

Update the Auvik credential when the UniFi API key is rotated or its configuration changes.

1. Go to Admin > Discovery > Manage Credentials.

2. Select the API Credentials tab.

3. Find the Ubiquiti UniFi credential and open its action menu.

4. Select Edit.

5. Enter the new API key or update the required settings.

6. Click Test Connection.

7. When the test succeeds, click Save.

• Collector is not approved for the site: The collector must be approved for the sites it is mapped to.

• Invalid or failed authentication: Confirm that the complete API key was copied from UniFi and has not expired or been revoked.

• Sites are missing: Confirm that the API key includes the Site Manager scope and that the required sites are selected.

• Network or Protect data is missing: Confirm that both the Network and Protect applications are enabled for the API key.

• Connection cannot be established: Confirm that the host URL is api.ui.com and that the selected Auvik collector can reach the required UniFi Cloud services.