端点

/api/system/removeWorkspaceDir

移除工作空间目录 (removeWorkspaceDir)

首页 | System API | GitHub Source (workspace.go)

功能描述

此 API 端点 POST /api/system/removeWorkspaceDir 用于从思源笔记的已知工作空间列表中移除一个指定的目录路径。

**重要提示：**此操作仅将该路径从配置文件 (workspace.json) 中移除，并不会删除磁盘上实际的目录或文件。如果需要彻底删除工作空间及其内容，请使用 /api/system/removeWorkspaceDirPhysically API（高风险！）。

无法移除当前正在使用的工作空间。

请求参数

请求体必须是 JSON 格式，包含以下参数：

• path (string): 必填。要从列表中移除的工作空间目录的绝对路径。

请求示例:

{
  "path": "/path/to/remove/workspace"
}

响应结果

成功的请求将返回一个 JSON 对象，code 为 0，data 为 null。

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

如果操作失败（例如尝试移除当前工作空间、无法读写工作空间列表文件等），将返回非 0 的 code 和具体的错误信息 msg。

{
  "code": -1,
  "msg": "Cannot remove current workspace", // 示例错误信息
  "data": {"closeTimeout": 3000} // 特定情况下可能包含 data
}

{
  "code": -1,
  "msg": "write workspace conf [...] failed: ...", // 示例错误信息
  "data": null
}

在线测试

您可以在下方输入要从列表中移除的工作空间目录的绝对路径进行在线测试。这不会删除实际文件。

API Token:
Endpoint:
Method:
Parameters (JSON):

发送请求

响应结果:

思源笔记 API 文档 | 最后更新时间：