思源笔记 API 文档

/api/system/exportConf

方法: POST

认证: `model.CheckAuth`, `model.CheckAdminRole` (需要登录,管理员权限)

功能: 导出思源笔记的配置到一个 ZIP 文件。导出的配置是经过清理和脱敏的版本,移除了部分用户特定数据和运行时状态信息。

请求参数

此 API 当前版本不需要任何功能性的请求参数。虽然服务器端可能尝试解析JSON请求体,但其中的参数不会影响导出内容。

请求示例

可以直接发送 POST 请求,无需特定请求体。


// 空请求体或任意JSON对象均可,例如:
{}
        

响应结果

成功时,返回的 JSON 对象中 code 为 0,msg 为空字符串。data 对象包含两个字段:


{
    "code": 0,
    "msg": "",
    "data": {
        "name": "siyuan-conf-20250511212400.json",
        "zip": "/export/siyuan-conf-20250511212400.json.zip"
    }
}
        

失败时 (例如,创建临时文件或 ZIP 包失败),code 非 0,msg 包含错误信息。


{
    "code": -1,
    "msg": "Failed to create export directory: ...error details...",
    "data": null // 或者可能包含 closeTimeout
}
        

在线测试

此 API 不需要特定参数,可直接发送请求。

响应: