api.ui.com) using an API key.
What Myrmex Can Do
Read inventory
List sites, consoles, UniFi devices, and connected clients across your estate, on demand.
Health & status
Check device status, adoption, and uptime for the sites you manage.
Hardening audit
Bring UniFi inventory into a Security Posture review.
Ask in the Workspace
Query your UniFi environment in plain language during investigations.
Before You Start
- A UniFi Site Manager account (
unifi.ui.com) with access to the consoles and sites you want to connect. - Permission to create an API key in Site Manager.
- The Console ID and Site ID for the console/site you want Myrmex to read.
Step 1 — Create the API Key in UniFi Site Manager
1
Open UniFi Site Manager
Sign in to the UniFi Site Manager at
unifi.ui.com.2
Create an API key
Open Settings → API (Control Plane) and create a new API Key. Give it a descriptive name.
3
Copy the key
Copy the generated key immediately and store it securely — it is shown only once. You’ll paste it into Myrmex.
4
Note the Console and Site IDs
Record the Console ID and Site ID for the environment you want Myrmex to read.
Step 2 — Add the Integration in Myrmex
From the Directory, choose Add Integration → UniFi Controller, then fill in:Connect
Click Connect to validate the API key and finish. UniFi then appears under Environment → Integrations, ready to query in the Workspace.Myrmex reads from UniFi in real time over the API each time you ask — nothing from your UniFi environment is stored on the Myrmex side.