the-real-unifi-mcp
Provides read/write access to the UniFi Site Manager and Network cloud APIs, enabling listing consoles and sites, inspecting devices and clients, and managing networks, WiFi broadcasts, firewall zones and policies, ACL rules, DNS policies, traffic matching lists, hotspot vouchers, switching, and SD-WAN configurations across UniFi deployments.
the-real-unifi-mcp
An MCP server that gives Claude (or any MCP client) full read/write access to the UniFi Site Manager and Network APIs over the official cloud endpoint. Cloud-only, stdio transport.
Unofficial project. This server is not affiliated with or endorsed by Ubiquiti Inc. UniFi and Ubiquiti are trademarks of Ubiquiti Inc., used here only to name the API this software works with; see NOTICE.
Point it at a UniFi Site Manager API key and your MCP client can list consoles, inspect devices and clients, and manage networks, WiFi, firewall policies, and more, through 169 tools covering the documented API surface.
Features
169 tools across both UniFi APIs, read and write.
Three-layer tool design: 86 hand-wrappers (10 Site Manager + 76 Network) + 82 auto-generated tools, one per documented endpoint + 1 raw-request escape hatch (86 + 82 + 1 = 169). The tool contract is pinned by
tests/contract/tools-contract.json.MCP resources and MCP prompts for ready-made workflows.
Lazy ID discovery (consoleId / Network siteId / Site Manager siteId), cached for the process lifetime.
Write guard on by default:
UNIFI_CONFIRM_WRITES(defaulttrue) turns destructive tools into preview-then-confirm; set it tofalseto execute writes directly. The model itself can sendconfirm: "YES", so this is a speed bump, not a human approval (see SECURITY.md).Secret redaction in the server's own stderr log lines (known key patterns and the configured API key by value).
Related MCP server: UnifiyMe
Requirements
Node.js 22.12 or a later 22.x, 24.x, or 26 and newer (
engines:^22.12.0 || ^24.0.0 || >=26.0.0, the range of the test toolchain vitest). Node 23 and 25 are not supported.UniFi Site Manager API key with Network scope. Create one at unifi.ui.com under Settings → API.
UniFi Console with firmware ≥ 5.0.3 (required by the Network API).
Installation
From npm (recommended)
No install step is needed: your MCP client starts the server with npx, which fetches the package from npm on first use.
npx -y the-real-unifi-mcp # starts the server on stdio; needs UNIFI_API_KEY in the environmentOr install it globally and use the the-real-unifi-mcp command:
npm install -g the-real-unifi-mcpPin a version (the-real-unifi-mcp@<version>) if you want updates only when you change the config. Releases from v0.2.1 on are published to npm from GitHub Actions with provenance (v0.2.0 is a GitHub release only); npm audit signatures verifies it.
From source
git clone https://github.com/mguttmann/the-real-unifi-mcp.git
cd the-real-unifi-mcp
npm ci
cp .env.example .env
# Edit .env: set UNIFI_API_KEY (Site Manager key with Network scope)
npm run build # prebuild runs lint, typecheck and unit tests first
npm start # node dist/index.js; reads .env from the current directoryAs MCPB bundle
npm ci
npm run build:mcpb
# Writes release/the-real-unifi-mcp-<version>.mcpb (install it in Claude Desktop) and its SBOM.The bundle maps its settings (API key, confirm writes, read-only, hide secrets, log level) to the environment variables below as ${user_config.<key>} placeholders. If a host starts the server without substituting them, a value that is still such a placeholder counts as unset: each switch keeps its default, the missing key stops the server, and a warning names the variable.
Releases from v0.2.0 on attach the .mcpb, the npm tarball, CycloneDX SBOMs and SHA256SUMS; see docs/RELEASING.md.
Configuration
Variable | Default | Description |
| (required) | Site Manager API key with Network scope |
|
| API base URL. This host receives the API key: leave it at the default unless you test against a local stub. Must be |
|
| If on, destructive tools require |
|
| Per-request timeout (ms), covering the response headers and the body |
|
|
|
| (unset) | Override discovery (pin to a specific console; needed when the account owns several consoles or a host of another type) |
| (unset) | Override discovery (pin to a specific Network site) |
| (unset) | Override discovery (pin to a specific Site Manager site) |
|
| If on, every tool with a |
|
| If on, every tool result has the fields the confirm preview redacts (passwords, WiFi passphrases, pre-shared keys, secrets, tokens, keys) replaced by |
|
| A tool result text longer than this many UTF-8 bytes is cut to it and ends with a |
Claude Desktop config
Add to claude_desktop_config.json (~/Library/Application Support/Claude/claude_desktop_config.json on macOS, %APPDATA%\Claude\claude_desktop_config.json on Windows):
{
"mcpServers": {
"unifi": {
"command": "npx",
"args": ["-y", "the-real-unifi-mcp"],
"env": {
"UNIFI_API_KEY": "<your Site Manager API key>"
}
}
}
}Any variable from Configuration can go into env. With a source checkout, use "command": "node" and "args": ["--env-file=/absolute/path/to/the-real-unifi-mcp/.env", "/absolute/path/to/the-real-unifi-mcp/dist/index.js"] instead.
Restart Claude Desktop after editing the file. The server exposes its tools under the unifi prefix.
Claude Code config
Register the server with the Claude Code CLI (--scope user makes it available in every project; the default scope, local, keeps it private to you in the current project):
claude mcp add --scope user unifi --env UNIFI_API_KEY="YOUR_SITE_MANAGER_API_KEY" -- npx -y the-real-unifi-mcpFrom a source checkout:
claude mcp add --scope user unifi -- node \
--env-file=/absolute/path/to/the-real-unifi-mcp/.env \
/absolute/path/to/the-real-unifi-mcp/dist/index.jsclaude mcp list shows whether it connects.
Tool reference
Site Manager hand-wrappers (10)
Account-level tools against api.ui.com directly:
unifi_sm_list_hosts: list all UniFi consoles on the account (optionalpageSize,nextToken)unifi_sm_get_host: detail for a single consoleunifi_sm_list_sites: account-level sites (optionalpageSize,nextToken); thestatisticsobject of each site is omitted unlessincludeStatistics: trueunifi_sm_list_devices: account-level device list (optionalhostIds,time,pageSize,nextToken)unifi_sm_get_isp_metrics: ISP metrics by bucket (5m/1h), forbeginTimestamp/endTimestampor aduration(24h, 7d, 30d)unifi_sm_query_isp_metrics: query ISP metrics with a time windowunifi_sm_list_sdwan_configs: SD-WAN configurationsunifi_sm_get_sdwan_config: single SD-WAN configurationunifi_sm_get_sdwan_config_status: status of an SD-WAN configurationunifi_sm_identity: resolved consoleId, networkSiteId, siteManagerSiteId
Network hand-wrappers (76)
Per-console tools via the Cloud Connector proxy, grouped by resource. Every unifi_net_list_* tool takes optional offset, limit and filter (vendor filter syntax); a result with more items carries a pagination hint with the next offset.
Info / Sites (2):
unifi_net_get_info,unifi_net_list_sitesDevices (9):
unifi_net_list_devices,unifi_net_get_device,unifi_net_get_device_stats,unifi_net_list_pending_devices,unifi_net_adopt_devices,unifi_net_device_action,unifi_net_reboot_device,unifi_net_port_action,unifi_net_remove_deviceClients (5):
unifi_net_list_clients,unifi_net_get_client,unifi_net_client_action,unifi_net_block_client,unifi_net_unblock_client(block/unblock return a "not supported" error: the Network API has no such client action)Networks (6):
unifi_net_list_networks,unifi_net_get_network,unifi_net_get_network_references,unifi_net_create_network,unifi_net_update_network,unifi_net_delete_networkWiFi broadcasts (5):
unifi_net_list_wifi,unifi_net_get_wifi,unifi_net_create_wifi,unifi_net_update_wifi,unifi_net_delete_wifiFirewall (13):
unifi_net_list_firewall_zones,unifi_net_get_firewall_zone,unifi_net_create_firewall_zone,unifi_net_update_firewall_zone,unifi_net_delete_firewall_zone,unifi_net_list_firewall_policies,unifi_net_get_firewall_policy,unifi_net_create_firewall_policy,unifi_net_update_firewall_policy,unifi_net_patch_firewall_policy,unifi_net_delete_firewall_policy,unifi_net_get_firewall_policy_ordering,unifi_net_reorder_firewall_policiesACL rules (7):
unifi_net_list_acl_rules,unifi_net_get_acl_rule,unifi_net_create_acl_rule,unifi_net_update_acl_rule,unifi_net_delete_acl_rule,unifi_net_get_acl_rule_ordering,unifi_net_reorder_acl_rulesDNS policies (5):
unifi_net_list_dns_policies,unifi_net_get_dns_policy,unifi_net_create_dns_policy,unifi_net_update_dns_policy,unifi_net_delete_dns_policyTraffic matching lists (5):
unifi_net_list_traffic_lists,unifi_net_get_traffic_list,unifi_net_create_traffic_list,unifi_net_update_traffic_list,unifi_net_delete_traffic_listHotspot vouchers (5):
unifi_net_list_vouchers,unifi_net_get_voucher,unifi_net_create_vouchers,unifi_net_delete_voucher,unifi_net_delete_vouchersSwitching (6):
unifi_net_list_switch_stacks,unifi_net_get_switch_stack,unifi_net_list_mclag_domains,unifi_net_get_mclag_domain,unifi_net_list_lags,unifi_net_get_lagSupporting (8):
unifi_net_list_wans,unifi_net_list_site_to_site_vpn,unifi_net_list_vpn_servers,unifi_net_list_radius_profiles,unifi_net_list_device_tags,unifi_net_list_dpi_application_categories,unifi_net_list_dpi_applications,unifi_net_list_countries
Auto-generated tools (82)
Named unifi_gen_<operationid> (the vendor operationId in lower case, e.g. unifi_gen_createfirewallpolicy, unifi_gen_getinfo). One tool per documented UniFi API endpoint (Site Manager API v1.0.0, Network API v11.0.97), except the Site Manager connector* proxy endpoints, which unifi_raw_request covers. siteId is auto-resolved from discovery; callers do not need to pass it. Write tools document the vendor request body in their body schema, but accept and send any body value unchanged, as in 0.2.1. unifi_gen_listsites omits the statistics object of each site unless includeStatistics: true, like unifi_sm_list_sites. See src/tools/generated/ for the full inventory.
Escape hatch (1)
unifi_raw_request(method, path, body?, query?): execute any HTTP method against api.ui.com{path}. The path must be relative; see SECURITY.md for what is refused. Auth, retry, error parsing, and pagination hints are handled automatically. Useful when no dedicated tool exists. It returns the response as is: GET /v1/sites here keeps the statistics object that unifi_sm_list_sites omits by default.
Errors
A failed call returns an error result whose details carry the HTTP statusCode (0 when no response arrived) and, when known, a code: the code from the UniFi API, or NETWORK_ERROR, REDIRECT_REFUSED, TIMEOUT or CANCELLED (the client cancelled the call).
Resources
unifi://identity: resolved consoleId + both siteIds + console metadataunifi://hosts: account hosts listunifi://hosts/{id}: single host detail
Prompts
unifi-audit-firewall: walks firewall zones and policies, flags weak rules, suggests hardeningunifi-network-health: configured WANs, device counts per state and pending firmware updates, connected clients by type and the most recently connectedunifi-adoption-status: pending adoptions report with adopt/reject recommendation
Write safety
By default (UNIFI_CONFIRM_WRITES unset or true), destructive tools require an explicit confirm: "YES" argument; without it they return a preview in which passwords, WiFi passphrases, pre-shared keys, secrets, tokens and keys in the body are replaced by (redacted). Set UNIFI_CONFIRM_WRITES=false to let destructive tools execute directly. Independent of these settings, a write tool refuses a body in which any value, at any depth, is exactly (redacted) (the placeholder of UNIFI_REDACT_SECRETS and of the preview): it returns an error with code: "REDACTED_PLACEHOLDER" and the paths of those fields, before any preview or request, so an object read with redaction on cannot overwrite a passphrase with the placeholder. Set the real value or omit the field:
{
"data": {
"preview": {
"tool": "unifi_net_create_vouchers",
"method": "POST",
"url": "/v1/connector/consoles/.../proxy/network/integration/v1/sites/.../hotspot/vouchers",
"body": { "count": 1, "name": "demo" }
},
"hint": "Write confirmation is on (UNIFI_CONFIRM_WRITES). Re-run with `confirm: \"YES\"` to apply this change."
}
}Every write tool also takes dry_run: true: it returns the same preview and never executes, also with confirm: "YES" or with UNIFI_CONFIRM_WRITES=false. With UNIFI_READ_ONLY=true, write tools refuse with code: "READ_ONLY" and send nothing; read tools keep working.
The model can send confirm: "YES" on its own, so the guard is a second step for the model, not a human approval. If you want to approve each write yourself, keep your MCP client's per-tool approval on for the write tools (all of them carry destructiveHint: true).
Examples
Prompts you can paste into Claude after installing the server:
"Show me all my UniFi networks and their VLAN IDs."
"Which of my UniFi devices are offline right now?"
"Audit my firewall posture: group rules by zone and flag any allow-any-any."
"Reboot the access point named
AP-Office-1.""Power-cycle PoE port 3 on the switch named
SW-Office."
Destructive examples respect UNIFI_CONFIRM_WRITES (default true): the model first gets a preview and has to call again with confirm: "YES" to apply.
Limitations
Cloud-only. All requests go through the UniFi cloud endpoint (
api.ui.com) via the Site Manager API and the Network Cloud Connector proxy. There is no direct-to-controller / local-network mode.Single account, owned consoles. Discovery resolves consoles your API key owns. Multi-console and multi-site accounts must pin IDs via the
UNIFI_*_IDvariables (see Troubleshooting).Auto-generated tools track the published docs. The
unifi_gen_*tools are generated from UniFi's documented endpoints; their input schemas are only as accurate as the upstream documentation. Useunifi_raw_requestif an endpoint behaves differently than its schema suggests.Network API requires recent firmware. The Network API is only available on consoles running firmware ≥ 5.0.3.
No event streaming / websockets. Tools are request/response only; there is no live event subscription.
Troubleshooting
"Discovery: no console found …"
Discovery takes the host of type console that your key owns; only when there is none, an owned host of type ucore (UniFi OS Server). If your console has another type, or the key owns none, set UNIFI_CONSOLE_ID=<id> (the id from unifi_sm_list_hosts).
"Discovery: multiple consoles match …"
Your Site Manager account has more than one UniFi console. Set UNIFI_CONSOLE_ID=<id> from one of the listed IDs. The same pattern applies to multi-Network-site (UNIFI_NETWORK_SITE_ID) and multi-Site-Manager-site (UNIFI_SITE_MANAGER_SITE_ID) cases.
401 Unauthorized
The API key is missing the Network scope or has been revoked. Re-generate the key at unifi.ui.com with both Site Manager and UniFi Applications → Network scopes enabled. Rotate any key that has ever been exposed in a chat or commit.
Tools not showing in Claude Desktop
Restart Claude Desktop after editing claude_desktop_config.json; config changes are only picked up on startup. The MCP log is at ~/Library/Logs/Claude/mcp-server-unifi.log (macOS); check it for startup errors or discovery failures.
Server stops right after a very large request
The MCP SDK closes the stdio transport when one incoming message exceeds its line limit (see SECURITY.md); the process then logs stdio transport closed on stderr and exits with code 1, without an error result. Split the input (for example fewer MACs or a smaller body per call) and restart the server.
Development
npm run dev # tsx watch
npm run test:unit # unit tests (offline; what prebuild runs)
npm test # unit tests (offline; the live smoke is not part of it)
npm run test:integration # live read-only smoke against api.ui.com (only with UNIFI_LIVE=1 and UNIFI_API_KEY)
npm run codegen # download the vendor OpenAPI docs and regenerate src/tools/generated/ (see CONTRIBUTING.md first)
npm run inspector # MCP Inspector
npm run build:mcpb # build MCPB bundle + SBOMs into release/
npm run lint # ESLint (type-aware, src, tests, scripts)
npm run typecheck # tsc --noEmit (src), then tsconfig.tests.json (tests, scripts)See CONTRIBUTING.md for the full workflow.
Architecture
Three-layer tool design. Hand-wrappers (unifi_sm_*, unifi_net_*) provide ergonomic, well-documented entry points for common operations with auto-resolved IDs and named arguments. The 82 auto-generated tools (unifi_gen_*) cover the endpoints listed in the codegen catalog (src/codegen/catalog.ts), with input schemas derived from the upstream UniFi docs. unifi_raw_request is the escape hatch for anything not covered by the first two layers.
Lazy ID discovery. On first use, the server calls GET /v1/hosts to find the owned console (type console, or ucore when no console matches), then GET /v1/sites (Network and Site Manager) to discover both siteIds. Results are cached for the process lifetime. Concurrent callers share a single in-flight request via stored promises. All three IDs can be pinned via environment variables for multi-console / multi-site accounts.
Retries. A request is tried at most 3 times. 429 is retried on every method, honouring Retry-After (capped at 60 s), because the server rejected the request. 5xx and dropped connections are retried only for GET; a POST, PUT, PATCH or DELETE is resent after a network error only when the connection was never established (for example ECONNREFUSED, ENOTFOUND), so a write that may already have reached UniFi is never duplicated. Redirects are refused (the API key never leaves the configured host) and timeouts are not retried. Network failures are returned as an error with the cause and logged at warn.
Codegen pipeline. A separate build step (npm run codegen) downloads the vendor OpenAPI documents (developer.ui.com/<api>/<version>/openapi.json) into tests/fixtures/openapi/, converts each catalogued operation into a Zod schema and emits one .ts file per endpoint. It writes nothing unless every catalog entry succeeds, and it fails on a vendor operation that is neither catalogued nor excluded. npm run codegen -- --offline regenerates from the committed documents; a unit test checks that the committed output equals that byte for byte. The output lives in src/tools/generated/ and is committed to git so builds work offline.
Security
API key is read from
UNIFI_API_KEYenvironment variable only. Never hardcoded..envis gitignored.An MCP client config that holds the key in
env(for exampleclaude_desktop_config.json) stores it in plain text; keep that file private.The stderr logger redacts known secret patterns (
UNIFI_API_KEY=...,X-API-Key,Authorization,apiKey,api_key, andapi_key/apikey/token/access_tokenquery parameters) and, by exact value, the configured API key wherever it appears. Output written by other tooling is not covered.Request paths are relative to the configured
UNIFI_API_BASEorigin, which must behttps://(plainhttp://only for loopback test stubs); the API key is sent only to that origin and redirects are refused.Error texts from the UniFi API are scrubbed like log lines and cut to a fixed length before they reach the model.
Keep
UNIFI_CONFIRM_WRITES=true(the default) for a confirmation step on destructive operations.Tool results carry strings controlled by whoever can name things in your UniFi setup (device names, client hostnames, SSIDs, rule descriptions). The server instructions tell the model to treat them as data; your MCP client should still ask you before destructive tools run. The threat model is in SECURITY.md.
To report a vulnerability, please use GitHub Security Advisories; do not open a public issue. See SECURITY.md.
Maintenance status
Maintained on a best-effort basis by one maintainer (@mguttmann) in spare time. There is no support contract and no guaranteed response time.
Security fixes take priority over features. Report vulnerabilities privately (see Security).
Dependency updates come from Dependabot; CI fails when a runtime dependency has a known high or critical advisory.
Only the latest minor release gets fixes.
The
unifi_gen_*tools follow the published UniFi API documentation; when Ubiquiti changes the API, they are regenerated in a later release. Open items are listed in BACKLOG.md.Issues and pull requests are welcome; see CONTRIBUTING.md and the Code of Conduct.
Contributing
See CONTRIBUTING.md.
License
MIT, see LICENSE. The vendor OpenAPI documents in tests/fixtures/openapi/ (Ubiquiti's developer documentation) are not covered by the MIT License; see NOTICE.
Available Tools
169 toolsunifi_gen_adoptdeviceunifi_gen_adoptdeviceCDestructive
Adopt Devices - generated from developer.ui.com/network/v11.0.97/adoptdevice
Inputs: body, confirm, dry_run.
unifi_gen_createaclruleunifi_gen_createaclruleCDestructive
Create ACL Rule - generated from developer.ui.com/network/v11.0.97/createaclrule
Inputs: body, confirm, dry_run.
unifi_gen_creatednspolicyunifi_gen_creatednspolicyCDestructive
Create DNS Policy - generated from developer.ui.com/network/v11.0.97/creatednspolicy
Inputs: body, confirm, dry_run.
unifi_gen_createfirewallpolicyunifi_gen_createfirewallpolicyCDestructive
Create Firewall Policy - generated from developer.ui.com/network/v11.0.97/createfirewallpolicy
Inputs: body, confirm, dry_run.
unifi_gen_createfirewallzoneunifi_gen_createfirewallzoneCDestructive
Create Custom Firewall Zone - generated from developer.ui.com/network/v11.0.97/createfirewallzone
Inputs: body, confirm, dry_run.
unifi_gen_createnetworkunifi_gen_createnetworkCDestructive
Create Network - generated from developer.ui.com/network/v11.0.97/createnetwork
Inputs: body, confirm, dry_run.
unifi_gen_createtrafficmatchinglistunifi_gen_createtrafficmatchinglistCDestructive
Create Traffic Matching List - generated from developer.ui.com/network/v11.0.97/createtrafficmatchinglist
Inputs: body, confirm, dry_run.
unifi_gen_createvouchersunifi_gen_createvouchersCDestructive
Generate Vouchers - generated from developer.ui.com/network/v11.0.97/createvouchers
Inputs: body, confirm, dry_run.
unifi_gen_createwifibroadcastunifi_gen_createwifibroadcastCDestructive
Create Wifi Broadcast - generated from developer.ui.com/network/v11.0.97/createwifibroadcast
Inputs: body, confirm, dry_run.
unifi_gen_deleteaclruleunifi_gen_deleteaclruleCDestructiveIdempotent
Delete ACL Rule - generated from developer.ui.com/network/v11.0.97/deleteaclrule
Inputs: aclRuleId (required), confirm, dry_run.
unifi_gen_deletednspolicyunifi_gen_deletednspolicyCDestructiveIdempotent
Delete DNS Policy - generated from developer.ui.com/network/v11.0.97/deletednspolicy
Inputs: dnsPolicyId (required), confirm, dry_run.
unifi_gen_deletefirewallpolicyunifi_gen_deletefirewallpolicyCDestructiveIdempotent
Delete Firewall Policy - generated from developer.ui.com/network/v11.0.97/deletefirewallpolicy
Inputs: firewallPolicyId (required), confirm, dry_run.
unifi_gen_deletefirewallzoneunifi_gen_deletefirewallzoneCDestructiveIdempotent
Delete Custom Firewall Zone - generated from developer.ui.com/network/v11.0.97/deletefirewallzone
Inputs: firewallZoneId (required), confirm, dry_run.
unifi_gen_deletenetworkunifi_gen_deletenetworkCDestructiveIdempotent
Delete Network - generated from developer.ui.com/network/v11.0.97/deletenetwork
Inputs: networkId (required), force, confirm, dry_run.
unifi_gen_deletetrafficmatchinglistunifi_gen_deletetrafficmatchinglistCDestructiveIdempotent
Delete Traffic Matching List - generated from developer.ui.com/network/v11.0.97/deletetrafficmatchinglist
Inputs: trafficMatchingListId (required), confirm, dry_run.
unifi_gen_deletevoucherunifi_gen_deletevoucherCDestructiveIdempotent
Delete Voucher - generated from developer.ui.com/network/v11.0.97/deletevoucher
Inputs: voucherId (required), confirm, dry_run.
unifi_gen_deletevouchersunifi_gen_deletevouchersCDestructiveIdempotent
Delete Vouchers - generated from developer.ui.com/network/v11.0.97/deletevouchers
Inputs: filter (required), confirm, dry_run.
unifi_gen_deletewifibroadcastunifi_gen_deletewifibroadcastCDestructiveIdempotent
Delete Wifi Broadcast - generated from developer.ui.com/network/v11.0.97/deletewifibroadcast
Inputs: wifiBroadcastId (required), force, confirm, dry_run.
unifi_gen_executeadopteddeviceactionunifi_gen_executeadopteddeviceactionDDestructive
Execute Adopted Device Action - generated from developer.ui.com/network/v11.0.97/executeadopteddeviceaction
Inputs: deviceId (required), body, confirm, dry_run.
unifi_gen_executeconnectedclientactionunifi_gen_executeconnectedclientactionCDestructive
Execute Client Action - generated from developer.ui.com/network/v11.0.97/executeconnectedclientaction
Inputs: clientId (required), body, confirm, dry_run.
unifi_gen_executeportactionunifi_gen_executeportactionCDestructive
Execute Port Action - generated from developer.ui.com/network/v11.0.97/executeportaction
Inputs: portIdx (required), deviceId (required), body, confirm, +1 more.
unifi_gen_getaclruleunifi_gen_getaclruleCRead-onlyIdempotent
Get ACL Rule - generated from developer.ui.com/network/v11.0.97/getaclrule
Inputs: aclRuleId (required).
unifi_gen_getaclruleorderingunifi_gen_getaclruleorderingBRead-onlyIdempotent
Get User-Defined ACL Rule Ordering - generated from developer.ui.com/network/v11.0.97/getaclruleordering
Inputs: no named parameters.
unifi_gen_getaclrulepageunifi_gen_getaclrulepageCRead-onlyIdempotent
List ACL Rules - generated from developer.ui.com/network/v11.0.97/getaclrulepage
Inputs: limit, filter, offset.
unifi_gen_getadopteddevicedetailsunifi_gen_getadopteddevicedetailsCRead-onlyIdempotent
Get Adopted Device Details - generated from developer.ui.com/network/v11.0.97/getadopteddevicedetails
Inputs: deviceId (required).
unifi_gen_getadopteddevicelateststatisticsunifi_gen_getadopteddevicelateststatisticsCRead-onlyIdempotent
Get Latest Adopted Device Statistics - generated from developer.ui.com/network/v11.0.97/getadopteddevicelateststatistics
Inputs: deviceId (required).
unifi_gen_getadopteddeviceoverviewpageunifi_gen_getadopteddeviceoverviewpageCRead-onlyIdempotent
List Adopted Devices - generated from developer.ui.com/network/v11.0.97/getadopteddeviceoverviewpage
Inputs: limit, filter, offset.
unifi_gen_getconnectedclientdetailsunifi_gen_getconnectedclientdetailsCRead-onlyIdempotent
Get Connected Client Details - generated from developer.ui.com/network/v11.0.97/getconnectedclientdetails
Inputs: clientId (required).
unifi_gen_getconnectedclientoverviewpageunifi_gen_getconnectedclientoverviewpageCRead-onlyIdempotent
List Connected Clients - generated from developer.ui.com/network/v11.0.97/getconnectedclientoverviewpage
Inputs: limit, filter, offset.
unifi_gen_getcountriesunifi_gen_getcountriesCRead-onlyIdempotent
List Countries - generated from developer.ui.com/network/v11.0.97/getcountries
Inputs: limit, filter, offset.
unifi_gen_getdevicetagpageunifi_gen_getdevicetagpageCRead-onlyIdempotent
List Device Tags - generated from developer.ui.com/network/v11.0.97/getdevicetagpage
Inputs: limit, filter, offset.
unifi_gen_getdnspolicyunifi_gen_getdnspolicyCRead-onlyIdempotent
Get DNS Policy - generated from developer.ui.com/network/v11.0.97/getdnspolicy
Inputs: dnsPolicyId (required).
unifi_gen_getdnspolicypageunifi_gen_getdnspolicypageCRead-onlyIdempotent
List DNS Policies - generated from developer.ui.com/network/v11.0.97/getdnspolicypage
Inputs: limit, filter, offset.
unifi_gen_getdpiapplicationcategoriesunifi_gen_getdpiapplicationcategoriesCRead-onlyIdempotent
List DPI Application Categories - generated from developer.ui.com/network/v11.0.97/getdpiapplicationcategories
Inputs: limit, filter, offset.
unifi_gen_getdpiapplicationsunifi_gen_getdpiapplicationsCRead-onlyIdempotent
List DPI Applications - generated from developer.ui.com/network/v11.0.97/getdpiapplications
Inputs: limit, filter, offset.
unifi_gen_getfirewallpoliciesunifi_gen_getfirewallpoliciesCRead-onlyIdempotent
List Firewall Policies - generated from developer.ui.com/network/v11.0.97/getfirewallpolicies
Inputs: limit, filter, offset.
unifi_gen_getfirewallpolicyunifi_gen_getfirewallpolicyCRead-onlyIdempotent
Get Firewall Policy - generated from developer.ui.com/network/v11.0.97/getfirewallpolicy
Inputs: firewallPolicyId (required).
unifi_gen_getfirewallpolicyorderingunifi_gen_getfirewallpolicyorderingCRead-onlyIdempotent
Get User-Defined Firewall Policy Ordering - generated from developer.ui.com/network/v11.0.97/getfirewallpolicyordering
Inputs: sourceFirewallZoneId (required), destinationFirewallZoneId (required).
unifi_gen_getfirewallzoneunifi_gen_getfirewallzoneDRead-onlyIdempotent
Get Firewall Zone - generated from developer.ui.com/network/v11.0.97/getfirewallzone
Inputs: firewallZoneId (required).
unifi_gen_getfirewallzonesunifi_gen_getfirewallzonesCRead-onlyIdempotent
List Firewall Zones - generated from developer.ui.com/network/v11.0.97/getfirewallzones
Inputs: limit, filter, offset.
unifi_gen_gethostbyidunifi_gen_gethostbyidCRead-onlyIdempotent
Get Host by ID - generated from developer.ui.com/site-manager/v1.0.0/gethostbyid
Inputs: id (required).
unifi_gen_getinfounifi_gen_getinfoCRead-onlyIdempotent
Get Application Info - generated from developer.ui.com/network/v11.0.97/getinfo
Inputs: no named parameters.
unifi_gen_getispmetricsunifi_gen_getispmetricsCRead-onlyIdempotent
Get ISP Metrics - generated from developer.ui.com/site-manager/v1.0.0/getispmetrics
Inputs: type (required), duration, endTimestamp, beginTimestamp.
unifi_gen_getlagunifi_gen_getlagCRead-onlyIdempotent
Get LAG Details - generated from developer.ui.com/network/v11.0.97/getlag
Inputs: lagId (required).
unifi_gen_getlagpageunifi_gen_getlagpageCRead-onlyIdempotent
List LAGs - generated from developer.ui.com/network/v11.0.97/getlagpage
Inputs: limit, filter, offset.
unifi_gen_getmclagdomainunifi_gen_getmclagdomainCRead-onlyIdempotent
Get MC-LAG Domain - generated from developer.ui.com/network/v11.0.97/getmclagdomain
Inputs: mcLagDomainId (required).
unifi_gen_getmclagdomainpageunifi_gen_getmclagdomainpageCRead-onlyIdempotent
List MC-LAG Domains - generated from developer.ui.com/network/v11.0.97/getmclagdomainpage
Inputs: limit, filter, offset.
unifi_gen_getnetworkdetailsunifi_gen_getnetworkdetailsDRead-onlyIdempotent
Get Network Details - generated from developer.ui.com/network/v11.0.97/getnetworkdetails
Inputs: networkId (required).
unifi_gen_getnetworkreferencesunifi_gen_getnetworkreferencesDRead-onlyIdempotent
Get Network References - generated from developer.ui.com/network/v11.0.97/getnetworkreferences
Inputs: networkId (required).
unifi_gen_getnetworksoverviewpageunifi_gen_getnetworksoverviewpageCRead-onlyIdempotent
List Networks - generated from developer.ui.com/network/v11.0.97/getnetworksoverviewpage
Inputs: limit, filter, offset.
unifi_gen_getpendingdevicepageunifi_gen_getpendingdevicepageCRead-onlyIdempotent
List Devices Pending Adoption - generated from developer.ui.com/network/v11.0.97/getpendingdevicepage
Inputs: limit, filter, offset.
unifi_gen_getradiusprofileoverviewpageunifi_gen_getradiusprofileoverviewpageCRead-onlyIdempotent
List Radius Profiles - generated from developer.ui.com/network/v11.0.97/getradiusprofileoverviewpage
Inputs: limit, filter, offset.
unifi_gen_getsdwanconfigbyidunifi_gen_getsdwanconfigbyidCRead-onlyIdempotent
Get SD-WAN Config by ID - generated from developer.ui.com/site-manager/v1.0.0/getsdwanconfigbyid
Inputs: id (required).
unifi_gen_getsdwanconfigstatusunifi_gen_getsdwanconfigstatusCRead-onlyIdempotent
Get SD-WAN Config Status - generated from developer.ui.com/site-manager/v1.0.0/getsdwanconfigstatus
Inputs: id (required).
unifi_gen_getsiteoverviewpageunifi_gen_getsiteoverviewpageCRead-onlyIdempotent
List Local Sites - generated from developer.ui.com/network/v11.0.97/getsiteoverviewpage
Inputs: limit, filter, offset.
unifi_gen_getsitetositevpntunnelpageunifi_gen_getsitetositevpntunnelpageCRead-onlyIdempotent
List Site-To-Site VPN Tunnels - generated from developer.ui.com/network/v11.0.97/getsitetositevpntunnelpage
Inputs: limit, filter, offset.
unifi_gen_getswitchstackunifi_gen_getswitchstackCRead-onlyIdempotent
Get Switch Stack - generated from developer.ui.com/network/v11.0.97/getswitchstack
Inputs: switchStackId (required).
unifi_gen_getswitchstackpageunifi_gen_getswitchstackpageCRead-onlyIdempotent
List Switch Stacks - generated from developer.ui.com/network/v11.0.97/getswitchstackpage
Inputs: limit, filter, offset.
unifi_gen_gettrafficmatchinglistunifi_gen_gettrafficmatchinglistCRead-onlyIdempotent
Get Traffic Matching List - generated from developer.ui.com/network/v11.0.97/gettrafficmatchinglist
Inputs: trafficMatchingListId (required).
unifi_gen_gettrafficmatchinglistsunifi_gen_gettrafficmatchinglistsCRead-onlyIdempotent
List Traffic Matching Lists - generated from developer.ui.com/network/v11.0.97/gettrafficmatchinglists
Inputs: limit, filter, offset.
unifi_gen_getvoucherunifi_gen_getvoucherCRead-onlyIdempotent
Get Voucher Details - generated from developer.ui.com/network/v11.0.97/getvoucher
Inputs: voucherId (required).
unifi_gen_getvouchersunifi_gen_getvouchersCRead-onlyIdempotent
List Vouchers - generated from developer.ui.com/network/v11.0.97/getvouchers
Inputs: limit, filter, offset.
unifi_gen_getvpnserverpageunifi_gen_getvpnserverpageCRead-onlyIdempotent
List VPN Servers - generated from developer.ui.com/network/v11.0.97/getvpnserverpage
Inputs: limit, filter, offset.
unifi_gen_getwansoverviewpageunifi_gen_getwansoverviewpageCRead-onlyIdempotent
List WAN Interfaces - generated from developer.ui.com/network/v11.0.97/getwansoverviewpage
Inputs: limit, offset.
unifi_gen_getwifibroadcastdetailsunifi_gen_getwifibroadcastdetailsCRead-onlyIdempotent
Get Wifi Broadcast Details - generated from developer.ui.com/network/v11.0.97/getwifibroadcastdetails
Inputs: wifiBroadcastId (required).
unifi_gen_getwifibroadcastpageunifi_gen_getwifibroadcastpageCRead-onlyIdempotent
List Wifi Broadcasts - generated from developer.ui.com/network/v11.0.97/getwifibroadcastpage
Inputs: limit, filter, offset.
unifi_gen_listdevicesunifi_gen_listdevicesCRead-onlyIdempotent
List Devices - generated from developer.ui.com/site-manager/v1.0.0/listdevices
Inputs: time, pageSize, hostIds[], nextToken.
unifi_gen_listhostsunifi_gen_listhostsCRead-onlyIdempotent
List Hosts - generated from developer.ui.com/site-manager/v1.0.0/listhosts
Inputs: pageSize, nextToken.
unifi_gen_listsdwanconfigsunifi_gen_listsdwanconfigsBRead-onlyIdempotent
List SD-WAN Configs - generated from developer.ui.com/site-manager/v1.0.0/listsdwanconfigs
Inputs: no named parameters.
unifi_gen_listsitesunifi_gen_listsitesCRead-onlyIdempotent
List Sites - generated from developer.ui.com/site-manager/v1.0.0/listsites
Inputs: pageSize, nextToken, includeStatistics.
unifi_gen_patchfirewallpolicyunifi_gen_patchfirewallpolicyCDestructiveIdempotent
Patch Firewall Policy - generated from developer.ui.com/network/v11.0.97/patchfirewallpolicy
Inputs: firewallPolicyId (required), body, confirm, dry_run.
unifi_gen_queryispmetricsunifi_gen_queryispmetricsCRead-onlyIdempotent
Query ISP Metrics - generated from developer.ui.com/site-manager/v1.0.0/queryispmetrics
Inputs: type (required), body, confirm, dry_run.
unifi_gen_removedeviceunifi_gen_removedeviceBDestructiveIdempotent
Remove (Unadopt) Device - generated from developer.ui.com/network/v11.0.97/removedevice
Inputs: deviceId (required), confirm, dry_run.
unifi_gen_updateaclruleunifi_gen_updateaclruleCDestructiveIdempotent
Update ACL Rule - generated from developer.ui.com/network/v11.0.97/updateaclrule
Inputs: aclRuleId (required), body, confirm, dry_run.
unifi_gen_updateaclruleorderingunifi_gen_updateaclruleorderingCDestructiveIdempotent
Reorder User-Defined ACL Rules - generated from developer.ui.com/network/v11.0.97/updateaclruleordering
Inputs: body, confirm, dry_run.
unifi_gen_updatednspolicyunifi_gen_updatednspolicyCDestructiveIdempotent
Update DNS Policy - generated from developer.ui.com/network/v11.0.97/updatednspolicy
Inputs: dnsPolicyId (required), body, confirm, dry_run.
unifi_gen_updatefirewallpolicyunifi_gen_updatefirewallpolicyCDestructiveIdempotent
Update Firewall Policy - generated from developer.ui.com/network/v11.0.97/updatefirewallpolicy
Inputs: firewallPolicyId (required), body, confirm, dry_run.
unifi_gen_updatefirewallpolicyorderingunifi_gen_updatefirewallpolicyorderingCDestructiveIdempotent
Reorder User-Defined Firewall Policies - generated from developer.ui.com/network/v11.0.97/updatefirewallpolicyordering
Inputs: sourceFirewallZoneId (required), destinationFirewallZoneId (required), body, confirm, +1 more.
unifi_gen_updatefirewallzoneunifi_gen_updatefirewallzoneCDestructiveIdempotent
Update Firewall Zone - generated from developer.ui.com/network/v11.0.97/updatefirewallzone
Inputs: firewallZoneId (required), body, confirm, dry_run.
unifi_gen_updatenetworkunifi_gen_updatenetworkDDestructiveIdempotent
Update Network - generated from developer.ui.com/network/v11.0.97/updatenetwork
Inputs: networkId (required), body, confirm, dry_run.
unifi_gen_updatetrafficmatchinglistunifi_gen_updatetrafficmatchinglistCDestructiveIdempotent
Update Traffic Matching List - generated from developer.ui.com/network/v11.0.97/updatetrafficmatchinglist
Inputs: trafficMatchingListId (required), body, confirm, dry_run.
unifi_gen_updatewifibroadcastunifi_gen_updatewifibroadcastCDestructiveIdempotent
Update Wifi Broadcast - generated from developer.ui.com/network/v11.0.97/updatewifibroadcast
Inputs: wifiBroadcastId (required), body, confirm, dry_run.
unifi_net_adopt_devicesAdopt pending devicesBDestructive
Adopts pending devices by MAC. Sends one adoption request per MAC and reports the result per MAC.
Inputs: macs (required), confirm, dry_run.
unifi_net_block_clientBlock clientADestructiveIdempotent
Not supported: the UniFi Network API defines no block action for clients, so this tool returns an error and sends nothing. Kept for compatibility.
Inputs: clientId (required), confirm, dry_run.
unifi_net_client_actionExecute client actionADestructive
Action on a connected client. Vendor values: AUTHORIZE_GUEST_ACCESS, UNAUTHORIZE_GUEST_ACCESS (lowercase and dashes are mapped). The Network API has no block/unblock action.
Inputs: action (required), clientId (required), confirm, dry_run.
unifi_net_create_acl_ruleCreate ACL ruleCDestructive
Creates a new ACL rule on the current site. Body shape per ACL API docs.
Inputs: body, confirm, dry_run.
unifi_net_create_dns_policyCreate DNS policyCDestructive
Creates a new DNS policy on the current site. Body shape per Network API docs.
Inputs: body, confirm, dry_run.
unifi_net_create_firewall_policyCreate firewall policyCDestructive
Creates a new firewall policy on the current site. Body shape per Firewall API docs.
Inputs: body, confirm, dry_run.
unifi_net_create_firewall_zoneCreate firewall zoneCDestructive
Creates a new firewall zone on the current site. Body shape per Firewall API docs.
Inputs: body, confirm, dry_run.
unifi_net_create_networkCreate networkCDestructive
Creates a new network on the current site. Body shape per Network API docs.
Inputs: body, confirm, dry_run.
unifi_net_create_traffic_listCreate traffic matching listCDestructive
Creates a new traffic matching list on the current site. Body shape per Network API docs.
Inputs: body, confirm, dry_run.
unifi_net_create_vouchersCreate vouchersCDestructive
Generates one or more hotspot vouchers. Body shape per UniFi docs (count, name, duration, …).
Inputs: body, confirm, dry_run.
unifi_net_create_wifiCreate WiFi broadcastCDestructive
Creates a new WLAN.
Inputs: body, confirm, dry_run.
unifi_net_delete_acl_ruleDelete ACL ruleCDestructiveIdempotent
Deletes an ACL rule on the current site. IRREVERSIBLE.
Inputs: id (required), confirm, dry_run.
unifi_net_delete_dns_policyDelete DNS policyCDestructiveIdempotent
Deletes a DNS policy. IRREVERSIBLE.
Inputs: id (required), confirm, dry_run.
unifi_net_delete_firewall_policyDelete firewall policyCDestructiveIdempotent
Deletes a firewall policy. IRREVERSIBLE.
Inputs: id (required), confirm, dry_run.
unifi_net_delete_firewall_zoneDelete firewall zoneBDestructiveIdempotent
Deletes a firewall zone. IRREVERSIBLE.
Inputs: id (required), confirm, dry_run.
unifi_net_delete_networkDelete networkCDestructiveIdempotent
Deletes a network. IRREVERSIBLE.
Inputs: id (required), confirm, dry_run.
unifi_net_delete_traffic_listDelete traffic matching listCDestructiveIdempotent
Deletes a traffic matching list. IRREVERSIBLE.
Inputs: id (required), confirm, dry_run.
unifi_net_delete_voucherDelete voucherBDestructiveIdempotent
Deletes a single hotspot voucher.
Inputs: id (required), confirm, dry_run.
unifi_net_delete_vouchersDelete vouchersADestructiveIdempotent
Deletes all vouchers matching filter (required by the API, sent as query parameter). body.filter is still accepted for compatibility.
Inputs: body, filter, confirm, dry_run.
unifi_net_delete_wifiDelete WiFi broadcastBDestructiveIdempotent
Deletes a WLAN. IRREVERSIBLE.
Inputs: id (required), confirm, dry_run.
unifi_net_device_actionExecute device actionCDestructive
Generic device action. Uses the executeadopteddeviceaction endpoint. Vendor value: RESTART (lowercase "restart" is mapped).
Inputs: action (required), deviceId (required), confirm, dry_run.
unifi_net_get_acl_ruleGet ACL ruleCRead-onlyIdempotent
Detail for one ACL rule on the current site.
Inputs: id (required).
unifi_net_get_acl_rule_orderingGet ACL rule orderingARead-onlyIdempotent
Returns the current ordering of ACL rules on the current site.
Inputs: no named parameters.
unifi_net_get_clientGet connected clientCRead-onlyIdempotent
Detail for a connected client by id.
Inputs: clientId (required).
unifi_net_get_deviceGet device detailsCRead-onlyIdempotent
Detail for a single adopted device.
Inputs: deviceId (required).
unifi_net_get_device_statsGet latest device statisticsDRead-onlyIdempotent
Latest statistics snapshot.
Inputs: deviceId (required).
unifi_net_get_dns_policyGet DNS policyCRead-onlyIdempotent
Detail for one DNS policy.
Inputs: id (required).
unifi_net_get_firewall_policyGet firewall policyCRead-onlyIdempotent
Detail for one firewall policy.
Inputs: id (required).
unifi_net_get_firewall_policy_orderingGet firewall policy orderingARead-onlyIdempotent
Returns the current ordering of firewall policies on the current site.
Inputs: no named parameters.
unifi_net_get_firewall_zoneGet firewall zoneCRead-onlyIdempotent
Detail for one firewall zone.
Inputs: id (required).
unifi_net_get_infoNetwork application infoARead-onlyIdempotent
Reads /v1/info on the Network application via the Cloud Connector. Useful as a health probe.
Inputs: no named parameters.
unifi_net_get_lagGet LAGCRead-onlyIdempotent
Link Aggregation Group (LAG) detail for a single LAG.
Inputs: id (required).
unifi_net_get_mclag_domainGet MCLAG domainCRead-onlyIdempotent
MCLAG domain detail for a single domain.
Inputs: id (required).
unifi_net_get_networkGet networkCRead-onlyIdempotent
Detail for one network.
Inputs: id (required).
unifi_net_get_network_referencesGet network referencesCRead-onlyIdempotent
References to this network from other objects.
Inputs: id (required).
unifi_net_get_switch_stackGet switch stackCRead-onlyIdempotent
Switch stack detail for a single stack.
Inputs: id (required).
unifi_net_get_traffic_listGet traffic matching listCRead-onlyIdempotent
Detail for one traffic matching list.
Inputs: id (required).
unifi_net_get_voucherGet voucherCRead-onlyIdempotent
Hotspot voucher detail for a single voucher.
Inputs: id (required).
unifi_net_get_wifiGet WiFi broadcastDRead-onlyIdempotent
Detail for a WLAN.
Inputs: id (required).
unifi_net_list_acl_rulesList ACL rulesBRead-onlyIdempotent
Lists all ACL rules on the current site.
Inputs: limit, filter, offset.
unifi_net_list_clientsList connected clientsCRead-onlyIdempotent
Currently connected clients on the site.
Inputs: limit, filter, offset.
unifi_net_list_countriesList countriesBRead-onlyIdempotent
List of countries available in the UniFi Network API (console-level, no siteId required).
Inputs: limit, filter, offset.
unifi_net_list_devicesList adopted devicesCRead-onlyIdempotent
Adopted UniFi devices on the current site.
Inputs: limit, filter, offset.
unifi_net_list_device_tagsList device tagsCRead-onlyIdempotent
Device tags configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_dns_policiesList DNS policiesBRead-onlyIdempotent
Lists all DNS policies configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_dpi_application_categoriesList DPI application categoriesCRead-onlyIdempotent
DPI application categories known to the UniFi Network API (console-level, no siteId required).
Inputs: limit, filter, offset.
unifi_net_list_dpi_applicationsList DPI applicationsCRead-onlyIdempotent
DPI applications known to the UniFi Network API (console-level, no siteId required).
Inputs: limit, filter, offset.
unifi_net_list_firewall_policiesList firewall policiesCRead-onlyIdempotent
Lists all firewall policies on the current site.
Inputs: limit, filter, offset.
unifi_net_list_firewall_zonesList firewall zonesCRead-onlyIdempotent
Lists all firewall zones on the current site.
Inputs: limit, filter, offset.
unifi_net_list_lagsList LAGsCRead-onlyIdempotent
Link Aggregation Groups (LAGs) configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_mclag_domainsList MCLAG domainsCRead-onlyIdempotent
MCLAG domains configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_networksList networksCRead-onlyIdempotent
Networks configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_pending_devicesList pending devicesBRead-onlyIdempotent
Devices waiting to be adopted (console-level, no siteId required).
Inputs: limit, filter, offset.
unifi_net_list_radius_profilesList RADIUS profilesCRead-onlyIdempotent
RADIUS profiles configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_sitesList Network sitesARead-onlyIdempotent
Lists the local sites that the Network application exposes (NOT the same as Site Manager sites).
Inputs: limit, filter, offset.
unifi_net_list_site_to_site_vpnList site-to-site VPN tunnelsCRead-onlyIdempotent
Site-to-site VPN tunnels configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_switch_stacksList switch stacksCRead-onlyIdempotent
Switch stacks configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_traffic_listsList traffic matching listsBRead-onlyIdempotent
Lists all traffic matching lists configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_vouchersList vouchersCRead-onlyIdempotent
Hotspot vouchers configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_vpn_serversList VPN serversCRead-onlyIdempotent
VPN servers configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_wansList WANsBRead-onlyIdempotent
WAN interfaces configured on the current site.
Inputs: limit, filter, offset.
unifi_net_list_wifiList WiFi broadcastsDRead-onlyIdempotent
WLAN broadcasts.
Inputs: limit, filter, offset.
unifi_net_patch_firewall_policyPatch firewall policyBDestructiveIdempotent
Partially updates an existing firewall policy (PATCH semantics).
Inputs: id (required), body, confirm, dry_run.
unifi_net_port_actionExecute switch port actionCDestructive
Action on a switch port. Vendor value: POWER_CYCLE (PoE power-cycle; "power-cycle" is mapped).
Inputs: action (required), portIdx (required), deviceId (required), body, +2 more.
unifi_net_reboot_deviceReboot deviceCDestructive
Convenience wrapper over device_action with action=RESTART.
Inputs: deviceId (required), confirm, dry_run.
unifi_net_remove_deviceRemove (unadopt) deviceCDestructiveIdempotent
Removes an adopted device from the site.
Inputs: deviceId (required), confirm, dry_run.
unifi_net_reorder_acl_rulesReorder ACL rulesCDestructiveIdempotent
Sets the ordering of ACL rules on the current site.
Inputs: body, confirm, dry_run.
unifi_net_reorder_firewall_policiesReorder firewall policiesCDestructiveIdempotent
Sets the ordering of firewall policies on the current site.
Inputs: body, confirm, dry_run.
unifi_net_unblock_clientUnblock clientADestructiveIdempotent
Not supported: the UniFi Network API defines no unblock action for clients, so this tool returns an error and sends nothing. Kept for compatibility.
Inputs: clientId (required), confirm, dry_run.
unifi_net_update_acl_ruleUpdate ACL ruleCDestructiveIdempotent
Updates an existing ACL rule on the current site (full replacement).
Inputs: id (required), body, confirm, dry_run.
unifi_net_update_dns_policyUpdate DNS policyCDestructiveIdempotent
Updates an existing DNS policy.
Inputs: id (required), body, confirm, dry_run.
unifi_net_update_firewall_policyUpdate firewall policyCDestructiveIdempotent
Updates an existing firewall policy (full replacement).
Inputs: id (required), body, confirm, dry_run.
unifi_net_update_firewall_zoneUpdate firewall zoneCDestructiveIdempotent
Updates an existing firewall zone.
Inputs: id (required), body, confirm, dry_run.
unifi_net_update_networkUpdate networkCDestructiveIdempotent
Updates an existing network.
Inputs: id (required), body, confirm, dry_run.
unifi_net_update_traffic_listUpdate traffic matching listCDestructiveIdempotent
Updates an existing traffic matching list.
Inputs: id (required), body, confirm, dry_run.
unifi_net_update_wifiUpdate WiFi broadcastCDestructiveIdempotent
Updates an existing WLAN.
Inputs: id (required), body, confirm, dry_run.
unifi_raw_requestUniFi raw requestADestructive
Generic escape hatch: executes ANY HTTP method against api.ui.com{path}. Use when no dedicated tool exists. Auth, retry, error parsing and pagination hints are handled automatically.
Inputs: path (required), method (required), body, query, +2 more.
unifi_sm_get_hostGet host detailBRead-onlyIdempotent
Account-level: detail for a single host (console).
Inputs: id (required).
unifi_sm_get_isp_metricsGet ISP metricsCRead-onlyIdempotent
ISP metrics for a granularity bucket.
Inputs: type (required), duration, endTimestamp, beginTimestamp.
unifi_sm_get_sdwan_configGet SD-WAN configurationCRead-onlyIdempotent
Get a single SD-WAN configuration.
Inputs: id (required).
unifi_sm_get_sdwan_config_statusGet SD-WAN configuration statusCRead-onlyIdempotent
Status of a SD-WAN configuration.
Inputs: id (required).
unifi_sm_identityResolved identityBRead-onlyIdempotent
Returns consoleId, networkSiteId, siteManagerSiteId: useful for sanity checks.
Inputs: no named parameters.
unifi_sm_list_devicesList devices (account)ARead-onlyIdempotent
Account-level devices view (not the deep Network-API per-site list).
Inputs: time, hostIds, pageSize, nextToken.
unifi_sm_list_hostsList hostsBRead-onlyIdempotent
Account-level: list all UniFi consoles linked to this Site Manager account.
Inputs: pageSize, nextToken.
unifi_sm_list_sdwan_configsList SD-WAN configurationsCRead-onlyIdempotent
Account-level SD-WAN configurations.
Inputs: no named parameters.
unifi_sm_list_sitesList Site Manager sitesCRead-onlyIdempotent
Account-level sites.
Inputs: pageSize, nextToken, includeStatistics.
unifi_sm_query_isp_metricsQuery ISP metricsCRead-onlyIdempotent
POST a time-window query for ISP metrics.
Inputs: type (required), body.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 169 tools
The set contains extensive duplication between curated tools and generated tools, e.g. unifi_net_list_networks vs unifi_gen_getnetworksoverviewpage, unifi_net_get_voucher vs unifi_gen_getvoucher, and multiple voucher/firewall/traffic-list variants. Some tools are also near-overlapping actions, such as unifi_net_device_action, unifi_net_reboot_device, and unifi_gen_executeadopteddeviceaction. An agent can often distinguish by prefix, but many boundaries are confusing.
Names mix three families: unifi_net_* snake_case, unifi_sm_* snake_case, and unifi_gen_* concatenated generated endpoint names like unifi_gen_getadopteddeviceoverviewpage. Even within the generated family, verb+resource casing is inconsistent and hard to parse. The surface is not predictable enough for reliable tool selection.
169 tools is far beyond a well-scoped MCP surface and includes many duplicate generated/curated pairs. This volume creates selection noise and maintenance burden rather than a coherent toolkit. The count is an extreme mismatch for practical agent use.
Coverage is broad across networks, Wi-Fi, firewall zones/policies, ACL rules, DNS policies, traffic lists, vouchers, devices, clients, SD-WAN, VPN, and ISP metrics, with many CRUD operations. There are notable dead-end compatibility tools such as unifi_net_block_client and unifi_net_unblock_client that intentionally error, and some resources are read-only, but the overall surface is extensive.
Maintenance
Related MCP Connectors
An MCP server that provides an API to LLMs to manage their JumpCloud resources.
MCP gateway and cloud hosting for MCP servers, agents and apps like RAG, managed from your agent.
The official MCP Server for the Mux API
Secure and manage MCP servers through the Speakeasy AI Control Plane from your agent.
Related MCP Servers
- -licenseNot gradedqualityNot gradedmaintenanceTurns your UniFi Network Controller into programmable tools for querying and modifying network settings via MCP.-
- AlicenseCqualityCmaintenanceA Model Context Protocol (MCP) server for UniFi Network Controllers that enables LLMs to interact with UniFi infrastructure for monitoring and control.51MIT
- AlicenseNot gradedqualityCmaintenanceA safety-first MCP server for managing UniFi networks, exposing 17 tools for telemetry, diagnostics, and guarded mutations with dry-run previews and confirm requirements.16MIT
- AlicenseNot gradedqualityCmaintenanceMCP server and CLI for UniFi Network controllers: clients, devices, WLANs, firewall, and health over stdio or streamable HTTP, with auth.5AGPL 3.0