# Cloudreve API Docs ## Docs - [README](https://32e2i1plvy.apifox.cn/7493400m0.md): ## API Docs - 站点信息 [健康检查](https://32e2i1plvy.apifox.cn/359742787e0.md): 获取实例的版本信息。 - 站点信息 [获取验证码](https://32e2i1plvy.apifox.cn/359742788e0.md): 请求验证码图像和票据。 - 站点信息 [获取站点设置](https://32e2i1plvy.apifox.cn/359742789e0.md): 按部分获取全局站点设置。只有您请求的部分中的设置将包含在您的响应中。 - 站点信息 [举报滥用](https://32e2i1plvy.apifox.cn/359742790e0.md): 举报分享链接或用户的滥用行为。 - 会话管理 > 令牌 [密码登录](https://32e2i1plvy.apifox.cn/359742792e0.md): - 会话管理 > 令牌 [完成双因素认证登录](https://32e2i1plvy.apifox.cn/359742793e0.md): 在[密码登录](apifox://link/endpoint/359742792)后，如果需要2FA，此API用于完成2FA挑战并获取一对令牌。 - 会话管理 > 令牌 [刷新令牌](https://32e2i1plvy.apifox.cn/359742794e0.md): 使用有效的刷新令牌刷新访问令牌。 - 会话管理 > 令牌 [退出登录](https://32e2i1plvy.apifox.cn/359742795e0.md): 注销当前会话并撤销刷新令牌。所有由根令牌发行的刷新令牌都将被撤销。对于SSO登录会话，此方法还会提供从SSO侧重定向的URL以注销其会话。 - 会话管理 > 开放ID [准备OpenID登录](https://32e2i1plvy.apifox.cn/359742796e0.md): 准备一个社交连接器登录，可以用于登录Cloudreve账户，或将现有账户与社交连接器账户链接。 - 会话管理 > 开放ID [完成OpenID登录](https://32e2i1plvy.apifox.cn/359742797e0.md): 在用户通过从[Prepare OpenID Sign-in](apifox://link/endpoint/359742796)获取的URL登录后，请求此操作以通知Cloudreve登录结果。 - 会话管理 > 开放ID [解绑OpenID](https://32e2i1plvy.apifox.cn/359742798e0.md): 从Cloudreve账户解绑OpenID账户。 - 会话管理 > 通行密钥 [准备通行密钥登录](https://32e2i1plvy.apifox.cn/359742799e0.md): 准备通行密钥登录会话。 - 会话管理 > 通行密钥 [完成通行密钥登录](https://32e2i1plvy.apifox.cn/359742800e0.md): - 会话管理 [准备登录](https://32e2i1plvy.apifox.cn/359742791e0.md): 查询给定的用户是否存在，以及所有可能的登录方法。此方法不需要进行登录，它仅提供更多的前端UI上下文。 - 用户管理 > 通行密钥 [准备通行密钥注册](https://32e2i1plvy.apifox.cn/359742811e0.md): 准备注册新的通行密钥。 - 用户管理 > 通行密钥 [完成通行密钥注册](https://32e2i1plvy.apifox.cn/359742812e0.md): - 用户管理 > 通行密钥 [删除通行密钥](https://32e2i1plvy.apifox.cn/359742813e0.md): 通过ID删除已注册的通行密钥。 - 用户管理 > 设置 [列出可用存储策略](https://32e2i1plvy.apifox.cn/359742814e0.md): 列出已认证用户的可用存储策略。 - 用户管理 > 设置 [列出可用节点](https://32e2i1plvy.apifox.cn/359742815e0.md): 列出分配给已认证用户的可用节点。 - 用户管理 > 设置 [获取偏好设置](https://32e2i1plvy.apifox.cn/359742816e0.md): - 用户管理 > 设置 [准备启用双因素认证](https://32e2i1plvy.apifox.cn/359742817e0.md): 在启用2FA之前，使用此方法获取用于生成QR码的TOTP密钥。 - 用户管理 > 设置 [更新偏好设置](https://32e2i1plvy.apifox.cn/359742818e0.md): 仅更新请求体中的非空字段。 - 用户管理 > 设置 [更新头像](https://32e2i1plvy.apifox.cn/359742819e0.md): 此方法的行为取决于请求体： - 用户管理 [用户注册](https://32e2i1plvy.apifox.cn/359742801e0.md): 从给定的电子邮件和密码创建一个新账户。 - 用户管理 [发送密码重置邮件](https://32e2i1plvy.apifox.cn/359742802e0.md): 为现有账户发送电子邮件以重置密码。 - 用户管理 [通过临时链接重置密码](https://32e2i1plvy.apifox.cn/359742803e0.md): 使用通过 [发送重置密码邮件](apifox://link/endpoint/359742802) 发送的临时URL中的 `secret` 重置账户密码。 - 用户管理 [获取头像](https://32e2i1plvy.apifox.cn/359742804e0.md): 获取指定用户的头像，可直接用作 `img` 标签的 `src` 属性，因为它输出原始图片而不是标准的 Cloudreve JSON 响应结构。 - 用户管理 [获取用户信息](https://32e2i1plvy.apifox.cn/359742805e0.md): 通过ID获取用户。授权是可选的，但匿名请求时`email`字段会被隐藏。 - 用户管理 [列出用户的分享链接](https://32e2i1plvy.apifox.cn/359742806e0.md): 列出给定用户创建的公共分享链接。 - 用户管理 [获取存储容量](https://32e2i1plvy.apifox.cn/359742807e0.md): 获取已认证用户的存储容量摘要。 - 用户管理 [搜索用户](https://32e2i1plvy.apifox.cn/359742808e0.md): 通过显示名称或电子邮件搜索其他用户。 - 用户管理 [列出积分变更记录](https://32e2i1plvy.apifox.cn/359742809e0.md): - 用户管理 [列出支付记录](https://32e2i1plvy.apifox.cn/359742810e0.md): - 回调 [完成OBS上传](https://32e2i1plvy.apifox.cn/359742820e0.md): 通知Cloudreve文件已上传到华为OBS。 - 回调 [完成OneDrive上传](https://32e2i1plvy.apifox.cn/359742821e0.md): 通知Cloudreve文件已上传到OneDrive。 - 回调 [完成COS上传](https://32e2i1plvy.apifox.cn/359742822e0.md): 通知Cloudreve文件已上传到腾讯COS。 - 回调 [完成S3上传](https://32e2i1plvy.apifox.cn/359742823e0.md): 通知Cloudreve文件已上传到S3。 - 工作流 > 远程下载 [创建远程下载](https://32e2i1plvy.apifox.cn/359742830e0.md): 创建远程下载任务。 - 工作流 > 远程下载 [选择要下载的文件](https://32e2i1plvy.apifox.cn/359742831e0.md): 在BitTorrent下载任务中选择/取消选择特定文件。此方法仅适用于正在进行的远程下载任务。对于请求中未包含的文件，其下载行为保持不变。 - 工作流 > 远程下载 [取消任务](https://32e2i1plvy.apifox.cn/359742832e0.md): 取消给定的远程下载任务。此方法仅适用于正在进行的远程下载任务。 - 工作流 [列出任务](https://32e2i1plvy.apifox.cn/359742824e0.md): 列出当前已认证用户触发的所有后台任务。 - 工作流 [获取任务进度](https://32e2i1plvy.apifox.cn/359742825e0.md): Get realtime progress of the given task. Note that not all phases and all task types support getting progress. Empty response will be returned if there's no available progress info. - 工作流 [创建压缩包](https://32e2i1plvy.apifox.cn/359742826e0.md): 创建任务以从现有文件创建新的压缩文件。 - 工作流 [提取压缩包](https://32e2i1plvy.apifox.cn/359742827e0.md): 创建任务以提取给定压缩文件中的所有文件。 - 工作流 [重新定位存储策略](https://32e2i1plvy.apifox.cn/359742828e0.md): 创建任务以重新定位给定文件的存储策略。 - 工作流 [导入外部文件](https://32e2i1plvy.apifox.cn/359742829e0.md): 创建一个任务，将外部物理文件导入给定用户的指定路径。**此方法仅限具有管理员权限的用户使用。** - 文件管理 > 权限管理 [设置权限](https://32e2i1plvy.apifox.cn/359742850e0.md): 设置文件权限。只有文件的所有者或管理员才能执行此操作。 - 文件管理 > 权限管理 [删除权限设置](https://32e2i1plvy.apifox.cn/359742851e0.md): 清除目标文件的现有权限设置，这些权限设置将在此操作后从父文件继承。只有文件的所有者或管理员才能执行此操作。 - 文件管理 > 上传 [创建上传会话](https://32e2i1plvy.apifox.cn/359742852e0.md): Create a upload session, which is required before uploading files. After upload session created, client should start uploading using the information included in the upload session. The implementation of upload differs from different storage policy type, you can find Cloudreve's implentation in [uploader](https://github.com/cloudreve/frontend/tree/master/src/component/Uploader/core/uploader). - 文件管理 > 上传 [上传文件分块](https://32e2i1plvy.apifox.cn/359742853e0.md): 将一个分块上传到Cloudreve。此方法仅适用于本地存储策略或启用了上传中继的存储策略。 - 文件管理 > 上传 [删除上传会话](https://32e2i1plvy.apifox.cn/359742854e0.md): 删除上传会话。客户端应在以下情况下发送此请求： - 文件管理 > 固定项 [固定到侧边栏](https://32e2i1plvy.apifox.cn/359742855e0.md): 将[URI](https://docs.cloudreve.org/api/file-uri)固定到用户的侧边栏。 - 文件管理 > 固定项 [删除固定项](https://32e2i1plvy.apifox.cn/359742856e0.md): 从用户的侧边栏中删除固定的URI。 - 文件管理 > 版本管理 [设置文件版本](https://32e2i1plvy.apifox.cn/359742857e0.md): 设置文件的当前版本。 - 文件管理 > 版本管理 [删除文件版本](https://32e2i1plvy.apifox.cn/359742858e0.md): 从文件的版本历史中删除版本。 - 文件管理 > 直链管理 [创建直链](https://32e2i1plvy.apifox.cn/359742859e0.md): 创建一个可以直接访问文件内容的直接链接。只有文件所有者或管理员可以创建直接链接。 - 文件管理 > 直链管理 [删除直链](https://32e2i1plvy.apifox.cn/359742860e0.md): 仅文件所有者可以删除直链。 - 文件管理 [列出文件](https://32e2i1plvy.apifox.cn/359742833e0.md): 列出给定 [URI](https://docs.cloudreve.org/api/file-uri) 下的文件，如果 URI 包含搜索条件，也可以用于搜索文件。 - 文件管理 [列出文件活动](https://32e2i1plvy.apifox.cn/359742834e0.md): - 文件管理 [获取文件信息](https://32e2i1plvy.apifox.cn/359742835e0.md): 通过文件ID的[URI](https://docs.cloudreve.org/api/file-uri)获取给定文件的信息。如果请求了额外信息，则会提供更多信息。 - 文件管理 [获取缩略图URL](https://32e2i1plvy.apifox.cn/359742836e0.md): Get the thumbnail URL of the given file. - 文件管理 [获取压缩包文件列表](https://32e2i1plvy.apifox.cn/359742837e0.md): 获取压缩文件的内容。仅支持`7z`或`zip`文件。 - 文件管理 [更新文件内容](https://32e2i1plvy.apifox.cn/359742838e0.md): 更新给定文件的内容，如果文件不存在，则将创建一个新文件并使用给定的内容。 - 文件管理 [创建查看器会话](https://32e2i1plvy.apifox.cn/359742839e0.md): 为第三方文件应用或WOPI客户端创建一个临时的WOPI会话，以便下载或编辑文件。 - 文件管理 [创建文件](https://32e2i1plvy.apifox.cn/359742840e0.md): 使用给定的URI和属性创建一个新文件。如果给定的`uri`的祖先文件夹不存在，它们将自动创建。 - 文件管理 [重命名文件](https://32e2i1plvy.apifox.cn/359742841e0.md): - 文件管理 [移动或复制文件](https://32e2i1plvy.apifox.cn/359742842e0.md): 将文件移动或复制到给定目标位置。 - 文件管理 [创建下载URL](https://32e2i1plvy.apifox.cn/359742843e0.md): 创建临时匿名URL以下载文件内容。 - 文件管理 [从回收站恢复](https://32e2i1plvy.apifox.cn/359742844e0.md): 将回收站中已删除的文件恢复到其原始位置。 - 文件管理 [删除文件](https://32e2i1plvy.apifox.cn/359742845e0.md): - 文件管理 [强制解锁](https://32e2i1plvy.apifox.cn/359742846e0.md): If a file is locked by other user/application, file mutation might fail with errors like below: - 文件管理 [修补元数据](https://32e2i1plvy.apifox.cn/359742847e0.md): 修改给定文件的[元数据](https://docs.cloudreve.org/api/metadata)。 - 文件管理 [挂载存储策略](https://32e2i1plvy.apifox.cn/359742848e0.md): 此方法将一个文件夹挂载到指定的存储策略。此文件夹中的所有新文件将优先使用挂载的存储策略。如果子文件夹从未挂载，则此设置可以被继承。 - 文件管理 [更新视图设置](https://32e2i1plvy.apifox.cn/359742849e0.md): 更新给定文件夹的视图设置。只有文件夹的所有者可以更新视图设置。 - 分享管理 [创建分享链接](https://32e2i1plvy.apifox.cn/359742861e0.md): 为给定文件创建共享链接。只有文件所有者或管理员可以创建共享链接。 - 分享管理 [编辑分享链接](https://32e2i1plvy.apifox.cn/359742862e0.md): 为给定文件创建共享链接。只有文件所有者或管理员可以创建共享链接。 - 分享管理 [获取分享链接信息](https://32e2i1plvy.apifox.cn/359742863e0.md): 从ID获取分享链接信息。 - 分享管理 [列出我的分享链接](https://32e2i1plvy.apifox.cn/359742864e0.md): - 分享管理 [删除分享链接](https://32e2i1plvy.apifox.cn/359742865e0.md): 仅分享链接的所有者或管理员可以删除它。 - VAS > 支付 [创建支付](https://32e2i1plvy.apifox.cn/359742866e0.md): 为给定产品创建支付。 - VAS > 支付 [获取支付状态](https://32e2i1plvy.apifox.cn/359742867e0.md): - VAS > 礼品码 [检查礼品码](https://32e2i1plvy.apifox.cn/359742868e0.md): 获取给定礼品码的详细信息，但不处理兑换。 - VAS > 礼品码 [兑换礼品码](https://32e2i1plvy.apifox.cn/359742869e0.md): - 用户组 [列出用户组](https://32e2i1plvy.apifox.cn/359742870e0.md): 列出所有用户组。 - WebDAV账号 [列出账号](https://32e2i1plvy.apifox.cn/359742871e0.md): 列出已认证用户下的所有WebDAV账号。 - WebDAV账号 [创建账号](https://32e2i1plvy.apifox.cn/359742872e0.md): 创建新的WebDAV账号。 - WebDAV账号 [更新账号](https://32e2i1plvy.apifox.cn/359742873e0.md): - WebDAV账号 [删除账号](https://32e2i1plvy.apifox.cn/359742874e0.md): ## Schemas - [Response](https://32e2i1plvy.apifox.cn/208355423d0.md): - [SiteConfig](https://32e2i1plvy.apifox.cn/208355424d0.md): - [User](https://32e2i1plvy.apifox.cn/208355425d0.md): - [Group](https://32e2i1plvy.apifox.cn/208355426d0.md): - [FileViewer](https://32e2i1plvy.apifox.cn/208355427d0.md): - [PaymentProvider](https://32e2i1plvy.apifox.cn/208355428d0.md): - [PaymentSetting](https://32e2i1plvy.apifox.cn/208355429d0.md): - [StorageProduct](https://32e2i1plvy.apifox.cn/208355430d0.md): - [GroupSKU](https://32e2i1plvy.apifox.cn/208355431d0.md): - [CaptchaFields](https://32e2i1plvy.apifox.cn/208355432d0.md): - [Token](https://32e2i1plvy.apifox.cn/208355433d0.md): - [LoginResponse](https://32e2i1plvy.apifox.cn/208355434d0.md): - [PermissionSetting](https://32e2i1plvy.apifox.cn/208355435d0.md): - [Share](https://32e2i1plvy.apifox.cn/208355436d0.md): - [PaginationResults](https://32e2i1plvy.apifox.cn/208355437d0.md): - [ListShareResponse](https://32e2i1plvy.apifox.cn/208355438d0.md): - [TaskListResponse](https://32e2i1plvy.apifox.cn/208355439d0.md): - [Node](https://32e2i1plvy.apifox.cn/208355440d0.md): - [TaskResponse](https://32e2i1plvy.apifox.cn/208355441d0.md): - [Progress](https://32e2i1plvy.apifox.cn/208355442d0.md): - [ArchiveWorkflowService](https://32e2i1plvy.apifox.cn/208355443d0.md): - [StoragePolicy](https://32e2i1plvy.apifox.cn/208355444d0.md): - [Entity](https://32e2i1plvy.apifox.cn/208355445d0.md): - [ExtendedInfo](https://32e2i1plvy.apifox.cn/208355446d0.md): - [FolderSummary](https://32e2i1plvy.apifox.cn/208355447d0.md): - [FileResponse](https://32e2i1plvy.apifox.cn/208355448d0.md): - [NavigatorProps](https://32e2i1plvy.apifox.cn/208355449d0.md): - [ListResponse](https://32e2i1plvy.apifox.cn/208355450d0.md): - [LogEntry](https://32e2i1plvy.apifox.cn/208355451d0.md): - [Activity](https://32e2i1plvy.apifox.cn/208355452d0.md): - [FileActivitiesResponse](https://32e2i1plvy.apifox.cn/208355453d0.md): - [ExplorerView](https://32e2i1plvy.apifox.cn/208355454d0.md): - [ListViewColumn](https://32e2i1plvy.apifox.cn/208355455d0.md): - [PinFileService](https://32e2i1plvy.apifox.cn/208355456d0.md): - [ShareCreateService](https://32e2i1plvy.apifox.cn/208355457d0.md): - [Payment](https://32e2i1plvy.apifox.cn/208355458d0.md): - [Passkey](https://32e2i1plvy.apifox.cn/208355459d0.md): - [DavAccount](https://32e2i1plvy.apifox.cn/208355460d0.md): - [CreateDavAccountService](https://32e2i1plvy.apifox.cn/208355461d0.md): - [CustomProps](https://32e2i1plvy.apifox.cn/208355462d0.md): - [CustomNavItem](https://32e2i1plvy.apifox.cn/208355463d0.md): - [CustomHTML](https://32e2i1plvy.apifox.cn/208355464d0.md): - [ArchivedFile](https://32e2i1plvy.apifox.cn/208355465d0.md):