触发启动时同步

API Endpoint: POST /api/sync/getBootSync

认证: 需要登录 (model.CheckAuth)。

功能描述

此 API 用于异步触发一次"启动时同步"(或称为"引导同步")。该操作会尝试从当前配置的云端同步服务下载初始的数据仓库状态 (.siyuan/repo)。这通常在首次设置同步、更换云端同步目标,或者需要从云端完整恢复数据仓库时使用。

重要提示:

请求参数 (JSON Body)

参数名 类型 是否必需 描述
app string 发起同步请求的客户端或应用程序的唯一标识符。此标识符可能用于后续的 WebSocket 通知,以便将同步状态反馈给正确的客户端。

请求示例:


{
    "app": "siyuan-desktop-v2.10.0"
}
        

响应

成功启动同步任务后,服务器返回 HTTP 状态码 200 和一个 JSON 对象,结构如下:


{
    "code": 0,
    "msg": "",
    "data": null
}
        

在线测试

响应:

点击按钮发送请求

注意:此操作为异步,请在思源笔记客户端或通过开发者工具检查 WebSocket 消息来确认同步状态。