SuperAPI AI 工具集

unifi-api

编程与开发

查看项目

更新于 10-16 05:47

技能介绍

用途:通过 UniFi OS 控制台的 REST API 查询与控制 UniFi 网络,已在 UDR-7(UniFi OS 4.x / Network Application 10.x)上测试。

主要能力:CLI 优先用于 Integration API,自动从 OpenAPI 规范发现操作,支持分页、输出格式与认证;可列出设备、已连接客户端、网络、防火墙策略等,共 44 个生成命令,覆盖设备、客户端、网络、防火墙、DNS、WiFi、热点、ACL 等。原始 API 用于 Legacy 端点(如 stat/sta、cmd/stamgr、rest/wlanconf),支持客户端封禁/踢出/遗忘、设备重启/升级/定位/电源循环、健康状态、网络与 VLAN、SSID 开关与改密、防火墙策略与区域、端口转发、时间序列统计、事件与告警、站点设置等。

使用方式:CLI 位于 ~/.local/bin/unifi,通过 op run 自动注入 1Password 中的 API 密钥,站点 ID 用 default 简写,由封装替换为真实 UUID,可用 UNIFI_SITE=<uuid> 覆盖。示例:unifi get-adopted-device-overview-page default;unifi get-connected-client-overview-page default --rsh-output-format json;unifi get-connected-client-overview-page default -f 'data[].{name, ipAddress, type}'。原始 API 使用 X-API-KEY 头,Integration API 路径为 /proxy/network/integration/v1/sites/{SITE},Legacy 为 /proxy/network/api/s/{SITE_S}。

适用场景:家庭或小型企业 UniFi 网络的自动化查询、监控与配置管理。

限制:部分 Integration API 端点在 UDR-7 固件 4.x 返回 404(如 /wifi-broadcasts、/dns-policies、多个 supporting-resources 端点),需改用 Legacy API;Legacy API 不在 OpenAPI 规范内;PATCH 需 requests 库或自定义请求类;TLS 验证被禁用以适应自签名证书,仅限可信局域网使用;破坏性命令(封禁、重启、升级、电源循环)执行前需确认 MAC。API 密钥不得硬编码或打印。