Declare a UniFi Access door or a UniFi Network controller

To control a UniFi Access door or a UniFi Network installation from Link’nX, first declare the door, with the API token of its Access controller, or the UniFi Network console, with a local account. These declarations are then used by actions, scenario triggers and KNX mappings.

Intended for administrators and installers who have the project, the gateway and the corresponding option. UniFi Access controls doors; UniFi Network manages network devices and clients. UniFi Protect, intended for video surveillance, is declared with the cameras.

Before you start

• UniFi Access: have ready the host and port of the Access controller, an API token authorized for this installation and the door to control. The installer confirms the creation of the token and the initial configuration of the controller.
• UniFi Network: have ready a UniFi OS console, its host and port, the Network site key and the credentials of a local account authorized to administer the controller.
• Enter the token and the credentials only in the Link’nX form, never in an e-mail.

Open the UniFi Access or UniFi Network list

1. Select the project and the gateway in Link’nX.
2. In the devices navigation, open Security & Access → UniFi Access or Smart Home → UniFi Network. You can also search for the family name. On a small screen, open the navigation first.
3. Click Add in the list.

If the entry is missing, check the context and the available option with the navigation guide. For a card marked Soon, ask support for access, the license or the model’s compatibility.

Declare a UniFi Access door

A declaration represents one door.

1. Fill in Name, up to 64 characters, for example Fictitious entrance.
2. In Host (hostname or IP), enter the controller by its network name or IP address, up to 128 characters.
3. Check Port, prefilled with 12445, and keep the port confirmed for the installation.
4. Fill in API token, hidden on screen. Below this field, the form reminds you that the clocks of the Access controller and of the gateway must be synchronized by NTP: an event dated more than 2 minutes ago is ignored.
5. In Controlled door, click Detect doors. Detection works before the first save, as soon as the host and the token are filled in.
6. Wait for the result, then select your door in Door. No door is chosen automatically.
7. Click the round button with a floppy disk, at the bottom right. Wait for Success!, then find the declaration in the list.

For several doors on the same controller, create one declaration per door. Before replacing the door of a declaration used by automations, check their targets.

Declare a UniFi Network controller

The form asks for the controller’s local account, not your Link’nX account: have it confirmed by the installer. Do not use an Access token instead of the username and password.

1. Fill in Name, up to 64 characters.
2. Enter Host (hostname or IP), up to 128 characters, for example console.example.test, a fictitious value to replace.
3. Check Port, prefilled with 443, according to the installed console.
4. Fill in Site, up to 64 characters, prefilled with default. Enter the confirmed site key: its display name may differ from it.
5. Fill in Username, up to 128 characters, and Password of the local account. Both fields are required. The password is shown in clear text while typing: hide it in any screenshot.
6. Click the floppy disk at the bottom right, wait for Success!, then check the list.

This form offers neither door detection nor automatic selection of network clients. For an older standalone controller on another port, have the path confirmed for your version: changing only the port is not enough to establish its compatibility.

Edit or delete a declaration

• Click the Edit pencil on the row, change the relevant fields, save, then review the declaration. For UniFi Access, door detection runs again when editing opens.
• Changing the host or the port can clear the door selection: run detection again and check the target. A manual entry not yet saved can also be replaced when detection succeeds.
• If you leave the form with unsaved changes, take the leave confirmation into account.
• In the list, the Delete trash can opens a confirmation. First check the automations that use the declaration: do not count on an automatic restore. See lists and confirmations.

Check the result

1. Reopen the declaration with Edit and review the host, the port and the door (Access) or the host, the port and the site (Network).
2. Then test a real function: Success! confirms that the declaration is saved, not that the controller accepts a command. Depending on the family, follow the UniFi Access actions, the UniFi Access triggers and KNX mappings, the UniFi Network actions or the UniFi Network presence and KNX mappings.

Troubleshooting

UniFi Access door detection displays one of the following results:

Message	Meaning	Action
Controller unreachable or invalid token…	Detection failed, without telling whether the host, the port, the token or network access is at fault	Check these four elements from the installation, then click Retry. If needed, enter in Door ID (manual entry) the UUID confirmed in the Access console, without guessing it
No door on this controller…	The controller answered with an empty list: this result differs from a failure and does not point to a wrong token	Check the doors in the UniFi Access console, then click Refresh. This result does not open manual entry; a new declaration cannot be saved without a door
Not found on the controller, with The saved door no longer exists on this controller — pick a detected door or check the Access console.	The old door remains displayed by its identifier, but it may no longer exist or be reachable	Check the console and select the door you want before saving. A temporary unavailability does not justify choosing another door at random

For UniFi Network, if actions or feedback remain unavailable, check the host, the port, the site key and the local account with the installer.

If these checks have already been done, write to support@can-nx.com with the context, the message displayed and the tests carried out. Hide the token, the password and private data in any screenshot, and never attach the credentials.