The CloudRadial AutomationAI UniFi Site Manager extension gives a workflow or agent a read-only view across all of your UniFi deployments through the UniFi Site Manager cloud API: the UniFi OS consoles (hosts) on your account, their sites and devices, device status, internet-health metrics, and SD-WAN configurations. This article covers what the extension can do, the API key and secrets it needs, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
- What the Extension Covers
- Creating the API Key
- Providing the Credentials to Your Runner
- A Read-Only Extension
- Skills
- Tips for Working With UniFi Data
What the Extension Covers
The extension calls the UniFi Site Manager cloud API and provides nine tools across these areas:
| Area | What you can automate |
| Hosts | List the UniFi OS consoles registered to your ui.com account, such as a Dream Machine, Cloud Key, or UniFi OS Server, and read one host's hardware model, firmware version, status, and uptime |
| Sites | List every site across all hosts, with each site's owning host and rolled-up statistics |
| Devices | List gateways, switches, and access points across your deployments, filtered to one or more hosts or taken as a point-in-time snapshot |
| Internet health | Read ISP and WAN metric samples (latency, packet loss, throughput, and uptime) for your gateways, and run a filtered query scoped to specific sites or hosts and a time window |
| SD-WAN | List SD-WAN configurations, read one configuration's topology, member sites, and settings, and check its deployment status across hubs and spokes |
Install it from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Creating the API Key
The extension signs in with a Site Manager API key, sent on every request.
- Sign in at
https://unifi.ui.comand go to Settings > API Keys. - Select Create New API Key.
- Copy the key right away. UniFi shows it only once.
The extension uses the UniFi Site Manager cloud API only. It does not use the Network Integration API on an individual console.
Providing the Credentials to Your Runner
Store two secrets in your runner's Key Vault with these exact names:
| Secret | Value |
Unifi-ApiUrl |
The Site Manager API base URL, https://api.ui.com/v1. It is the same for every account. |
Unifi-ApiKey |
The Site Manager API key you created |
For how to add secrets, see Accessing and updating your runner's Key Vault.
A Read-Only Extension
All nine tools only read data, so none of them pause a run for approval. The extension cannot adopt, configure, or reboot a device, or change any setting in UniFi. The Site Manager API makes only list, get, and query operations generally available, so the extension does not include write actions.
The filtered internet-health query is sent as a POST request but only reads metric samples.
Skills
The extension ships three skills that guide an agent through common UniFi tasks. All of them are read-only.
| Skill | Use it to |
| Inventory UniFi Sites and Hosts | Take stock of the consoles (hosts) and sites across all deployments on your account |
| Review Devices and Status | Inventory gateways, switches, and access points, or check which devices are online or offline across one or all deployments |
| Check Internet and ISP Health | Assess WAN and internet health (latency, packet loss, throughput, and uptime) or review SD-WAN configuration and deployment status |
To give an agent these skills, see Creating custom agents and using them in workflows.
Tips for Working With UniFi Data
- A host is a UniFi OS console. A host runs one or more sites, and each site contains devices. To scope sites or devices to one console, the agent finds the host id first.
- The device list includes only devices on hosts where your account is an owner or super admin
- List tools return the complete set in one call, so you do not need to page through results
- For internet-health metrics, choose 5-minute samples for a window of up to 24 hours, or hourly samples for up to 7 or 30 days. Give either a duration or a start and end time, not both.
- The internet-health and SD-WAN endpoints are early-access in UniFi and are rate-limited more tightly than the rest of the API, to about 100 requests per minute. A workflow that calls them in a loop can receive a rate-limit error.
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.