Xpersona
U

UniFi Advisor

CLAWHUB · Unverified

Read-only UniFi network advisor covering the Site Manager cloud API and the Network Integration API. Query devices, clients, networks, firewall zones and pol...

62
Rank
84
Safety
993
Downloads

About

What it does, and when to use it.

Capability contract not published. No trust telemetry is available yet. 993 downloads reported by the source. Last updated 10/11/2026.

Avoid when

  • Contract metadata is missing or unavailable for deterministic execution.

Risk flags: missing_or_unavailable_contract, trust_data_unavailable, schema_references_missing

Install and run

Setup complexity: low.

clawhub skill install s172mg1aabwe4y035d4cj7pk2186agtj:unifi-advisor
  1. Install using `clawhub skill install s172mg1aabwe4y035d4cj7pk2186agtj:unifi-advisor` in an isolated environment before connecting it to live workloads.
  2. No published capability contract is available yet, so validate auth and request/response behavior manually.
  3. Review the upstream CLAWHUB listing at https://clawhub.ai/arseni-mik/unifi-advisor before using production credentials.

Contract: missing

curl -s "https://www.xpersona.co/api/v1/agents/clawhub-arseni-mik-unifi-advisor/snapshot"

Run-check

$0.02 USD

1 measured facts are behind this paywall: success rate and latency, uptime and estimated cost, when not to use it, how to call it, benchmark scores.

Agents pay $0.02 in USDC. A card payment is $0.50, the smallest a card allows.

Documentation

CLAWHUB

51,701 characters of source documentation, loaded on request.

Extracted files

4 files captured from the source.

SKILL.md

---
name: unifi-advisor
description: Read-only UniFi network advisor covering the Site Manager cloud API and the Network Integration API. Query devices, clients, networks, firewall zones and policies, ACL rules, DNS policies, VPN tunnels, DPI, ISP metrics, and related UniFi state. Use when inspecting UniFi environments with GET-only operations and no writes.
metadata: {"openclaw":{"requires":{"env":["UNIFI_API_KEY"],"bins":["python3"]},"primaryEnv":"UNIFI_API_KEY"}}
---

# UniFi Network Advisor

Read-only skill covering two official UniFi API surfaces. All operations are GET-only — no writes, no mutations of any kind.

## API surfaces

Everything goes through `https://api.ui.com`. No direct local connection required.

| Prefix | Surface | Proxied via | Env vars needed |
|---|---|---|---|
| SM | Site Manager | `api.ui.com/v1/...` | `UNIFI_API_KEY` |
| NET | Network Integration | `api.ui.com/v1/connector/consoles/{hostId}/proxy/network/integration/v1/...` | `UNIFI_API_KEY` (host/site resolved automatically) |

## How to call the script

```
python3 {baseDir}/scripts/unifi.py <subcommand> [--site SITE] [--id ID] [--limit N] [--next-token TOKEN] [subcommand-specific flags]
```

Some subcommands require additional flags — see the table below. Use `python3 {baseDir}/scripts/unifi.py list` to see all subcommands with descriptions.

## Subcommands

### Site Manager (SM) — cloud, single API key

| Subcommand | Endpoint | Required flags | Description |
|---|---|---|---|
| `hosts` | GET /v1/hosts | — | All UniFi OS consoles on the UI account |
| `host` | GET /v1/hosts/{id} | `--id` | Console details |
| `sites` | GET /v1/sites | — | All sites across all consoles |
| `cloud-devices` | GET /v1/devices | — | All devices across all sites |
| `isp-metrics` | GET /ea/isp-metrics/{type} | — | ISP performance metrics |
| `sdwan` | GET /v1/sd-wan-configs | — | SD-WAN configurations |
| `sdwan-config` | GET /v1/sd-wan-configs/{id} | `--id` | Specific SD-WAN config |
| `sdwan-status` | GET /v1/sd-wan-configs/{id}/status | `--id` | SD-WAN deployment status |

### Network Integration (NET) — proxied via api.ui.com, site resolved automatically

| Subcommand | Endpoint | Required flags | Description |
|---|---|---|---|
| `info` | GET /v1/info | — | Controller version and capabilities |
| `net-sites` | GET /v1/sites | — | Sites managed by this console |
| `devices` | GET /v1/sites/{siteId}/devices | — | Adopted devices overview |
| `device` | GET /v1/sites/{siteId}/devices/{id} | `--id` | Device details |
| `device-stats` | GET /v1/sites/{siteId}/devices/{id}/statistics/latest | `--id` | Latest device statistics |
| `devices-pending` | GET /v1/pending-devices | — | Devices pending adoption (console-scoped) |
| `clients` | GET /v1/sites/{siteId}/clients | — | Connected clients overview |
| `client` | GET /v1/sites/{siteId}/clients/{id} | `--id` | Client details |
| `networks` | GET /v1/sites/{siteId}/networks | — | Networks overview |
| `network` | GET /v1/sites/{siteId}/ne

README.md

# OpenClaw UniFi Skill

A read-only [OpenClaw](https://openclaw.ai) skill that lets your AI assistant query your UniFi network and give advice on devices, clients, firewall configuration, VPN tunnels, ISP performance, and more — GET-only, no writes of any kind.

## What it does

Covers two official UniFi API surfaces:

**Site Manager API** (cloud, cross-site):
- Lists all consoles, sites, and devices on your UI account
- ISP performance metrics and SD-WAN configurations

**Network Integration API** (proxied via api.ui.com):
- Devices, clients, networks, WiFi SSIDs
- Firewall zones, policies, ACL rules, DNS policies
- VPN tunnels and servers, WAN interfaces
- Hotspot vouchers, RADIUS profiles, device tags
- DPI categories and applications

**All queries are GET-only. No writes, no mutations.**

## Structure

```
open_claw-unifi-skill/
├── SKILL.md           # Skill definition and agent instructions
└── scripts/
    └── unifi.py       # Query script
```

## Requirements

- A UI account at [unifi.ui.com](https://unifi.ui.com)
- Python 3 on the host running OpenClaw

## Setup

### 1. Generate an API key

Sign in at [unifi.ui.com](https://unifi.ui.com) → **Settings → API Keys** → create a new key.
The same key works for both the Site Manager and Network Integration APIs.

### 2. Set the API key on your OpenClaw host

```bash
export UNIFI_API_KEY=your-api-key-here
```

That's it. Host and site IDs are discovered automatically from your UI account on every invocation (cached for 15 minutes). No other env vars needed.

### 3. Install the skill

```bash
# From ClawHub (once published):
openclaw skills install unifi-advisor

# Or locally:
openclaw skills install /path/to/open_claw-unifi-skill
```

## Usage

Ask your assistant naturally:

- *"Are all my UniFi devices online?"*
- *"Which clients are connected right now?"*
- *"Show me my firewall policies and check for anything too broad"*
- *"Is my VPN tunnel up?"*
- *"How is my ISP performing?"*
- *"What networks and VLANs do I have configured?"*

If you have multiple sites, specify which one: *"Check the firewall on my HQ site"* or *"What clients are on the branch office network?"*

Or call directly for testing:

```bash
python3 scripts/unifi.py list                         # all available subcommands
python3 scripts/unifi.py library                      # show discovered sites
python3 scripts/unifi.py devices --site hq            # adopted devices on a specific site
python3 scripts/unifi.py clients --limit 20           # connected clients
python3 scripts/unifi.py firewall-policies            # firewall policies
python3 scripts/unifi.py isp-metrics --metric-type 1h # ISP performance
```

## All subcommands

### Site Manager (cloud)

| Subcommand | Description |
|---|---|
| `library` | Show discovered sites with labels, state, and API capabilities |
| `hosts` | All UniFi OS consoles on the UI account |
| `host` | Console details (`--id` required) |
| `sites` | All sites across all consoles |
| `cloud-device

_meta.json

{
  "ownerId": "kn74nm91h4fsbqyqpypsxv4gj586bqnn",
  "slug": "unifi-advisor",
  "version": "1.0.2",
  "publishedAt": 1780234302431
}

skill-card.md

## Description:

Read-only UniFi network advisor covering the Site Manager cloud API and the Network Integration API for devices, clients, networks, firewall policy, VPN, DPI, ISP metrics, and related UniFi state.

This skill is ready for commercial/non-commercial use.

## Publisher:

[arseni-mik](https://clawhub.ai/user/arseni-mik)

### License/Terms of Use:

MIT-0

## Use Case:

Network operators, IT administrators, and support engineers use this skill to inspect UniFi environments, query read-only API state, and receive guidance about device health, clients, firewall policy, VPN status, ISP metrics, and related network configuration.

### Deployment Geography for Use:

Global

## Known Risks and Mitigations:

Risk: The skill can expose sensitive UniFi account, network inventory, client, firewall, VPN, voucher, IP address, and firmware information.

Mitigation: Install and run it only where read access to the UniFi cloud account and returned network details are acceptable, and treat outputs as confidential.

Risk: Site inventory metadata is cached locally for about 15 minutes without explicit permission hardening by the script.

Mitigation: Use the skill on trusted hosts and account profiles where local cache files are protected by the surrounding operating system permissions.

## Reference(s):

- [ClawHub Skill Page](https://clawhub.ai/arseni-mik/skills/unifi-advisor)
- [OpenClaw](https://openclaw.ai)
- [UniFi Portal](https://unifi.ui.com)
- [UniFi API Host](https://api.ui.com)

## Skill Output:

**Output Type(s):** [guidance, shell commands, configuration, text]

**Output Format:** [Markdown with inline shell commands and summarized JSON API results]

**Output Parameters:** [1D]

**Other Properties Related to Output:** [Outputs may include sensitive network inventory, client, firewall, VPN, IP address, voucher, firmware, and performance details from the user's UniFi account.]

## Skill Version(s):

1.0.2 (source: server release evidence)

## Ethical Considerations:

Users should evaluate whether this skill is appropriate for their environment, review any generated or modified files before relying on them, and apply their organization's safety, security, and compliance requirements before deployment.

Sponsored

Ads related to UniFi Advisor and adjacent AI workflows.