/api/sync/removeCloudSyncDir

删除指定云存储提供商上的一个同步目录。

API 端点详情

请求参数 (JSON Body)

参数名 类型 是否必需 描述
provider string 是 云服务提供商的名称。例如："S3", "WebDAV", "LocalFolder"。不能为空。
path string 是 要在云端删除的目录的路径或名称。不能为空。这个通常是之前通过 /api/sync/listCloudSyncDir 获取到的目录名。

请求示例:

{
    "provider": "S3",
    "path": "my-siyuan-sync-repo-to-delete"
}

响应详情

成功时，API 返回一个标准的成功响应，其中 data 字段为 null。

成功响应示例 (code: 0):

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

失败响应示例:

如果提供商名称或路径为空，或者删除操作失败，API会返回错误信息。

{
    "code": -1,
    "msg": "provider can not be empty", // 或 "path can not be empty", 或其他底层错误信息
    "data": null
}

重要提示

在线测试





响应:

点击按钮测试...