Skip to content

接口与健康检查

这一页列出本地部署最常用的公开接口。接口细节以后会继续补充。

登录与当前用户

方法路径作用
POST/api/setup/admin初始化本地管理员。
POST/api/auth/login登录。
POST/api/auth/logout退出登录。
GET/api/auth/me查看当前登录状态。

订阅

方法路径作用
GET/api/subscriptions读取订阅列表。
POST/api/subscriptions创建订阅。
GET/api/subscriptions/:id读取一个订阅。
PUT/api/subscriptions/:id更新一个订阅。
DELETE/api/subscriptions/:id删除一个订阅。
POST/api/subscriptions/:id/refresh手动刷新订阅。
GET/api/subscriptions/:token/config.yaml读取生成的 YAML。

模板与规则

方法路径作用
GET/api/templates读取模板列表。
POST/api/templates创建私有模板。
DELETE/api/templates删除私有模板。
GET/api/rules/search搜索规则。
GET/api/rules/cn-candidates查找中国规则候选。

健康检查

方法路径作用
GET/api/health/live应用进程是否存活。
GET/api/health/ready数据库等依赖是否就绪。

SubBoost 文档面向部署、使用和维护。