Connect Captive Portal to your UniFi console

To authorize guests, Captive Portal must be able to talk to your UniFi console. You need three things: an API key, a port forwarding rule to the console and the site details in the dashboard.

1. Create the API key in UniFi Network

1. In UniFi Network, open Integrations from the sidebar.

2. Click Create New API Key.

3. Give it a recognisable name, for example captive-portal, and set Expiry to Never Expires.

4. Click Create and copy the key: you will need it shortly in the Captive Portal dashboard.

UniFi Network → Integrations → Create New API Key

2. Set up port forwarding to the console

Our server reaches the console over HTTPS. On the site’s router or firewall, create a port forwarding rule:

3. Connect the site in Captive Portal

1. In the dashboard, open Sites and pick the site, or create a new one.

2. In the UniFi controller section, set Mode to Real UniFi.

3. In Host / IP, enter the site’s public address with the external port, for example https://203.0.113.10:20443.

4. In API key, paste the key created in UniFi.

5. If the console uses its own self-signed certificate (the usual case with an IP address), untick Verify TLS certificate.

6. Click Save.

The site’s UniFi controller section

Run the test and pick the Site

1. In the Connection test box, click Run test.

2. If the connection works, you see the list of UniFi Sites on the console: click the right one to fill in the Site field.

3. Leave UniFi site name (URL) as default, unless your UniFi site has a different short name.

4. Click Save.

If the test fails

Once the test works, set up the hotspot: Set up the UniFi hotspot for Captive Portal.