API 参考

80+ 端点,完整的 REST API

认证

所有 /api/v1/ 端点(/health 除外)需要 Bearer Token 认证。

Authorization: Bearer <token>

速率限制

速率限制:600 请求/分钟

端点列表

认证

方法路径说明
POST/api/v1/auth/login登录获取 Token
POST/api/v1/auth/logout登出
GET/api/v1/auth/status认证状态

备份源

方法路径说明
GET/api/v1/sources列出备份源
POST/api/v1/sources创建备份源
GET/api/v1/sources/{id}获取备份源
PUT/api/v1/sources/{id}更新备份源
DELETE/api/v1/sources/{id}删除备份源

备份操作

方法路径说明
POST/api/v1/backup/run触发备份
GET/api/v1/backup/progress备份进度
GET/api/v1/backup/state备份状态
POST/api/v1/backup/cancel取消备份

快照

方法路径说明
GET/api/v1/snapshots列出快照
GET/api/v1/snapshots/{id}快照详情
GET/api/v1/snapshots/changes快照变更

文件浏览与历史

方法路径说明
GET/api/v1/files浏览文件
GET/api/v1/history版本历史
GET/api/v1/history/content文件内容
GET/api/v1/history/diff差异对比
POST/api/v1/history/restore恢复文件

仓库

方法路径说明
GET/api/v1/repositories列出仓库
POST/api/v1/repositories创建仓库
GET/api/v1/repositories/{id}仓库详情
PUT/api/v1/repositories/{id}更新仓库
DELETE/api/v1/repositories/{id}删除仓库

云存储

方法路径说明
GET/api/v1/cloud/backends列出云后端
POST/api/v1/cloud/backends创建云后端
POST/api/v1/cloud/test测试连接

保留与 GC

方法路径说明
POST/api/v1/retention/apply应用保留策略
POST/api/v1/retention/gc运行 GC
POST/api/v1/retention/verify验证备份

监控

方法路径说明
GET/api/v1/oversight/health健康检查
GET/api/v1/oversight/alerts告警列表
POST/api/v1/oversight/patrol运行巡逻

加密密钥

方法路径说明
POST/api/v1/keys/export导出密钥
POST/api/v1/keys/import导入密钥