API Endpoint: POST /api/sync/getBootSync
认证: 需要登录 (model.CheckAuth
)。
此 API 用于异步触发一次"启动时同步"(或称为"引导同步")。该操作会尝试从当前配置的云端同步服务下载初始的数据仓库状态 (.siyuan/repo
)。这通常在首次设置同步、更换云端同步目标,或者需要从云端完整恢复数据仓库时使用。
重要提示:
syncProgress
, syncDone
, syncFail
等事件,具体事件名需参考实际实现)。/api/sync/setSyncProvider
等接口)。参数名 | 类型 | 是否必需 | 描述 |
---|---|---|---|
app |
string | 是 | 发起同步请求的客户端或应用程序的唯一标识符。此标识符可能用于后续的 WebSocket 通知,以便将同步状态反馈给正确的客户端。 |
请求示例:
{
"app": "siyuan-desktop-v2.10.0"
}
成功启动同步任务后,服务器返回 HTTP 状态码 200
和一个 JSON 对象,结构如下:
{
"code": 0,
"msg": "",
"data": null
}
code
(number): 0
表示同步任务已成功启动,其他值表示启动失败。msg
(string): 错误信息(如果 code
非 0
)。data
(null): 此接口不返回具体数据,固定为 null
。点击按钮发送请求
注意:此操作为异步,请在思源笔记客户端或通过开发者工具检查 WebSocket 消息来确认同步状态。