API — 配置文件、预设与路由

列出和导入身份、管理预设和域名路由规则,并注册端口所经过的网关。

配置文件

GET /api/v1/profiles 需要鉴权

列出已存储的身份,可选分页和浏览器筛选。

参数类型必填说明
limitint (query)每页数量(默认 100)。
offsetint (query)分页偏移量(默认 0)。
browserstring (query)按浏览器筛选,例如 "chrome"。
示例 (curl)
curl -H "X-API-Key: YOUR_API_KEY" "http://127.0.0.1:8891/api/v1/profiles?browser=chrome&limit=50"
GET /api/v1/counts 需要鉴权

返回每个浏览器系列存在多少个身份。

示例 (curl)
curl -H "X-API-Key: YOUR_API_KEY" http://127.0.0.1:8891/api/v1/counts
响应
{ "Chrome": 10000, "Firefox": 500, "Safari": 300, "Edge": 200 }

端口的身份

POST /api/v1/port/{port}/rotate 需要鉴权

在当前筛选条件范围内,将端口轮换为另一个身份。

示例 (curl)
curl -H "X-API-Key: YOUR_API_KEY" -X POST http://127.0.0.1:8891/api/v1/port/20134/rotate
GET /api/v1/port/{port}/profile/view 需要鉴权

返回端口当前所呈现的完整身份。

示例 (curl)
curl -H "X-API-Key: YOUR_API_KEY" http://127.0.0.1:8891/api/v1/port/20134/profile/view

预设

预设用于保存并重新应用端口配置,可按文件夹进行组织。

GET /api/v1/presets 需要鉴权

列出已保存的预设和文件夹。

POST /api/v1/presets 需要鉴权

保存一个预设。

POST /api/v1/presets/load 需要鉴权

将一个预设加载到端口上。

DELETE /api/v1/presets 需要鉴权

删除一个预设。

域名路由规则

GET /api/v1/domain_rules 需要鉴权

返回有序的域名路由规则列表。

PUT /api/v1/domain_rules 需要鉴权

替换域名路由规则。每条规则匹配域名,并通过所选路由发送它们,可附带可选的伪装覆盖设置。

网关 (OpenVPN / VLESS)

GET /api/v1/ovpn 需要鉴权

列出已保存的网关及其隧道状态。

POST /api/v1/ovpn 需要鉴权

添加一个网关(一个 .ovpn 文件或一个 vless:// 链接)。

PUT /api/v1/ovpn/{name} 需要鉴权

更新一个已有的网关。

DELETE /api/v1/ovpn/{name} 需要鉴权

删除一个网关(若正在使用则会被拒绝)。

GET /api/v1/gateway/openvpn-status 需要鉴权

报告主机上 OpenVPN/VLESS 后端是否可用。