Skip to Content
ConnectorsUniFi Access

Connect UniFi Access

Before you begin

You need:

  • an online, paired Musterly Runner
  • the full UniFi Access controller URL, as reached from the Runner machine
  • a UniFi API token with read access to Access devices

Use a dedicated UniFi account or token where your controller supports it. This makes it easier to rotate the token without affecting a person’s normal administrator login.

Create the UniFi token

In the UniFi OS console:

  1. Open Settings → Admins & Users.
  2. Select the administrator or service account Musterly will use.
  3. Open API Token.
  4. Generate a token and copy it.

The account needs read access to UniFi Access. UniFi menu names can differ between controller versions; if API Token is not shown, check that you are in the console settings rather than the Access application settings.

Configure the connector

  1. Open Settings → Integrations.
  2. Select Add connector, then UniFi Access.
  3. Give the connector a useful name.
  4. Enter the controller URL, including https:// and the port if it is not the standard HTTPS port.
  5. Paste the API token.
  6. Choose the site.
  7. Save the connector.
  8. Edit or add the Runner and assign this connector to it.

The controller URL must work from the Runner machine. A hostname that works on your laptop may not resolve on the server.

Verify the connection

Return to the Setup Centre. Musterly marks the sync step complete after the Runner connects to UniFi and sends a successful result. The building can be empty; a successful empty response still proves the connection works.

Next, use a real credential at a connected external door. Confirm the name, door, direction and time shown in the Setup Centre to finish setup.

After the first sync

Open Doors and classify the discovered doors. New doors start as External. Change room-to-room doors to Internal and anything irrelevant to Ignored.

If the sync fails, keep the error shown in Musterly and follow Troubleshooting. Do not send the API token in a support ticket.

Last updated on