UniFi Integration API

Use this skill for read-only UniFi monitoring through a UniFi API key.

Setup

Create the credentials file:

INLINECODE0

Example:

CODEBLOCK0

Notes:

• - token is the UniFi API key
• Requests use header INLINECODE2
• Scripts resolve the site ID automatically from INLINECODE3
• INLINECODE4 is used for classic read-only endpoints such as stat/health, stat/alarm, rest/networkconf, and INLINECODE8

Commands

Sites

CODEBLOCK1

List available UniFi sites and their IDs.

Health

CODEBLOCK2

Show a compact summary with device totals, online/offline counts, roles, and client counts.

Devices

CODEBLOCK3

Show UniFi infrastructure devices with model, IP, state, firmware, and feature roles.

Clients

CODEBLOCK4

Show connected clients with type, IP, MAC, connection time, and uplink device ID.

Dashboard

CODEBLOCK5

Show a combined overview including:

• - site and console info
• UniFi version
• health subsystems
• devices
• networks
• WLANs
• top client list
• recent alarms summary

Alerts / alarms

CODEBLOCK6

Show recent UniFi alarms. If none exist, report that there are no recent alarms.

Top apps / DPI

CODEBLOCK7

Show top applications by DPI if the gateway returns DPI data. If not, report that no DPI data is currently available.

Current endpoint coverage

Working endpoints validated on this gateway:

• - INLINECODE9
• INLINECODE10
• INLINECODE11
• INLINECODE12
• INLINECODE13
• INLINECODE14
• INLINECODE15
• INLINECODE16
• INLINECODE17

Caveats:

• - alarms/events may legitimately return zero items
• DPI may return an empty payload even when the endpoint itself is reachable
• some management/config endpoints expose sensitive data; avoid dumping full raw payloads unless explicitly needed

Workflow

When the user asks:

• - "check UniFi" / "dashboard" → run INLINECODE18
• "is everything healthy?" → run INLINECODE19
• "show devices" → run INLINECODE20
• "who is on the network?" / "clients" → run INLINECODE21
• "what sites exist?" → run INLINECODE22
• "any alarms?" / "alerts" → run INLINECODE23
• "top apps" / "traffic" / "DPI" → run INLINECODE24

Always sanity-check the response before reporting back:

• - verify the API returned JSON
• verify counts look reasonable
• if alarms or DPI are empty, say they are empty rather than treating that as an auth or endpoint failure
• avoid pasting sensitive management payloads back to the user unless they explicitly ask for raw details