2026-01-26 22:21:11 +08:00
|
|
|
|
# 接口列表
|
|
|
|
|
|
|
|
|
|
|
|
## 公共
|
|
|
|
|
|
|
|
|
|
|
|
- `GET /healthz`:健康检查
|
|
|
|
|
|
|
|
|
|
|
|
## 账号认证(/api/auth)
|
|
|
|
|
|
|
|
|
|
|
|
- `POST /api/auth/register`:注册
|
|
|
|
|
|
- `POST /api/auth/register/send`:发送邮箱验证码
|
|
|
|
|
|
- `POST /api/auth/register/verify`:验证邮箱验证码
|
|
|
|
|
|
- `POST /api/auth/login`:登录
|
2026-03-17 08:51:01 +08:00
|
|
|
|
- `POST /api/auth/token/exchange`:一次性 OAuth `exchange_code` 换取真实会话 token
|
2026-01-26 22:21:11 +08:00
|
|
|
|
- `POST /api/auth/token/refresh`:刷新 access token
|
|
|
|
|
|
|
|
|
|
|
|
### 需要会话(或受保护)
|
|
|
|
|
|
|
|
|
|
|
|
- `GET /api/auth/session`:获取当前会话用户
|
|
|
|
|
|
- `DELETE /api/auth/session`:注销
|
|
|
|
|
|
- `POST /api/auth/mfa/totp/provision`:申请 MFA TOTP secret
|
|
|
|
|
|
- `POST /api/auth/mfa/totp/verify`:验证 MFA TOTP
|
|
|
|
|
|
- `POST /api/auth/mfa/disable`:关闭 MFA
|
|
|
|
|
|
- `GET /api/auth/mfa/status`:查询 MFA 状态
|
|
|
|
|
|
- `POST /api/auth/password/reset`:发起密码重置(需要登录)
|
|
|
|
|
|
- `POST /api/auth/password/reset/confirm`:确认密码重置
|
|
|
|
|
|
- `GET /api/auth/subscriptions`:订阅列表
|
|
|
|
|
|
- `POST /api/auth/subscriptions`:订阅 upsert
|
|
|
|
|
|
- `POST /api/auth/subscriptions/cancel`:取消订阅
|
|
|
|
|
|
- `POST /api/auth/config/sync`:配置同步(当前返回未实现)
|
|
|
|
|
|
- `GET /api/auth/admin/settings`:获取权限矩阵
|
|
|
|
|
|
- `POST /api/auth/admin/settings`:更新权限矩阵
|
|
|
|
|
|
- `GET /api/auth/admin/users/metrics`:用户指标
|
|
|
|
|
|
- `GET /api/auth/admin/agents/status`:Agent 状态
|
|
|
|
|
|
|
|
|
|
|
|
> 说明:`/api/auth/admin/*` 需要管理员或运维角色。
|
|
|
|
|
|
|
2026-02-05 16:52:10 +08:00
|
|
|
|
## Agent API(/api/agent-server/v1)
|
2026-01-26 22:21:11 +08:00
|
|
|
|
|
2026-02-05 16:52:10 +08:00
|
|
|
|
- `GET /api/agent-server/v1/nodes`:获取已注册节点列表(用户会话鉴权)
|
|
|
|
|
|
- `GET /api/agent-server/v1/users`:获取 Xray 客户端列表
|
|
|
|
|
|
- `POST /api/agent-server/v1/status`:上报 Agent 状态
|
2026-01-26 22:21:11 +08:00
|
|
|
|
|
2026-02-05 16:52:10 +08:00
|
|
|
|
- `GET /nodes` 使用用户会话(`xc_session` / Bearer session token)
|
|
|
|
|
|
- `GET /users` 与 `POST /status` 使用 Agent Token:`Authorization: Bearer <agent-token>`
|