1. 文件管理
Cloudreve API Docs
  • README
  • 站点信息
    • 健康检查
      GET
    • 获取验证码
      GET
    • 获取站点设置
      GET
    • 举报滥用
      POST
  • 会话管理
    • 令牌
      • 密码登录
      • 完成双因素认证登录
      • 刷新令牌
      • 退出登录
    • 开放ID
      • 准备OpenID登录
      • 完成OpenID登录
      • 解绑OpenID
    • 通行密钥
      • 准备通行密钥登录
      • 完成通行密钥登录
    • 准备登录
      GET
  • 用户管理
    • 通行密钥
      • 准备通行密钥注册
      • 完成通行密钥注册
      • 删除通行密钥
    • 设置
      • 列出可用存储策略
      • 列出可用节点
      • 获取偏好设置
      • 准备启用双因素认证
      • 更新偏好设置
      • 更新头像
    • 用户注册
    • 发送密码重置邮件
    • 通过临时链接重置密码
    • 获取头像
    • 获取用户信息
    • 列出用户的分享链接
    • 获取存储容量
    • 搜索用户
    • 列出积分变更记录
    • 列出支付记录
  • 回调
    • 完成OBS上传
    • 完成OneDrive上传
    • 完成COS上传
    • 完成S3上传
  • 工作流
    • 远程下载
      • 创建远程下载
      • 选择要下载的文件
      • 取消任务
    • 列出任务
    • 获取任务进度
    • 创建压缩包
    • 提取压缩包
    • 重新定位存储策略
    • 导入外部文件
  • 文件管理
    • 权限管理
      • 设置权限
      • 删除权限设置
    • 上传
      • 创建上传会话
      • 上传文件分块
      • 删除上传会话
    • 固定项
      • 固定到侧边栏
      • 删除固定项
    • 版本管理
      • 设置文件版本
      • 删除文件版本
    • 直链管理
      • 创建直链
      • 删除直链
    • 列出文件
      GET
    • 列出文件活动
      GET
    • 获取文件信息
      GET
    • 获取缩略图URL
      GET
    • 获取压缩包文件列表
      GET
    • 更新文件内容
      PUT
    • 创建查看器会话
      PUT
    • 创建文件
      POST
    • 重命名文件
      POST
    • 移动或复制文件
      POST
    • 创建下载URL
      POST
    • 从回收站恢复
      POST
    • 删除文件
      DELETE
    • 强制解锁
      DELETE
    • 修补元数据
      PATCH
    • 挂载存储策略
      PATCH
    • 更新视图设置
      PATCH
  • 分享管理
    • 创建分享链接
    • 编辑分享链接
    • 获取分享链接信息
    • 列出我的分享链接
    • 删除分享链接
  • VAS
    • 支付
      • 创建支付
      • 获取支付状态
    • 礼品码
      • 检查礼品码
      • 兑换礼品码
  • 用户组
    • 列出用户组
  • WebDAV账号
    • 列出账号
    • 创建账号
    • 更新账号
    • 删除账号
  • 数据模型
    • Response
    • SiteConfig
    • User
    • Group
    • FileViewer
    • PaymentProvider
    • PaymentSetting
    • StorageProduct
    • GroupSKU
    • CaptchaFields
    • Token
    • LoginResponse
    • PermissionSetting
    • Share
    • PaginationResults
    • ListShareResponse
    • TaskListResponse
    • Node
    • TaskResponse
    • Progress
    • ArchiveWorkflowService
    • StoragePolicy
    • Entity
    • ExtendedInfo
    • FolderSummary
    • FileResponse
    • NavigatorProps
    • ListResponse
    • LogEntry
    • Activity
    • FileActivitiesResponse
    • ExplorerView
    • ListViewColumn
    • PinFileService
    • ShareCreateService
    • Payment
    • Passkey
    • DavAccount
    • CreateDavAccountService
    • CustomProps
    • CustomNavItem
    • CustomHTML
    • ArchivedFile
  1. 文件管理

列出文件

GET
/file
列出给定 URI 下的文件,如果 URI 包含搜索条件,也可以用于搜索文件。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数

Header 参数

返回响应

🟢200Success
application/json
Bodyapplication/json

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location '/file?uri=cloudreve%3A%2F%2Fmy%2FLuke%27s%20AMA&page=0&page_size=50&order_by=created_at&order_direction=asc&next_page_token=4%7CeyJpZCI6InJwR3pZMUY1In0%3D' \
--header 'X-Cr-Purchase-Ticket: 1f63aa26-edc0-40ce-950a-cb4d4323158e' \
--header 'Authorization: Bearer <token>'
响应示例响应示例
{
    "code": 0,
    "data": {
        "files": [
            {
                "type": 1,
                "id": "N93dL8ig",
                "name": "Takeout",
                "permission": null,
                "created_at": "2025-02-13T20:14:15+08:00",
                "updated_at": "2025-02-13T20:17:36+08:00",
                "size": 0,
                "metadata": {},
                "path": "cloudreve://my/Luke's%20AMA/Takeout",
                "capability": "39/9",
                "owned": true,
                "primary_entity": "zOie"
            },
            {
                "type": 1,
                "id": "8zXA03uL",
                "name": "新建文件夹",
                "permission": null,
                "created_at": "2025-02-20T15:16:28+08:00",
                "updated_at": "2025-02-20T15:16:28+08:00",
                "size": 0,
                "metadata": {
                    "tag:asd": ""
                },
                "path": "cloudreve://my/Luke's%20AMA/%E6%96%B0%E5%BB%BA%E6%96%87%E4%BB%B6%E5%A4%B9",
                "capability": "39/9",
                "owned": true,
                "primary_entity": "zOie"
            },
            {
                "type": 0,
                "id": "8zXBp3UL",
                "name": "sample.psd",
                "permission": null,
                "created_at": "2025-05-22T14:34:24+08:00",
                "updated_at": "2025-05-22T14:34:24+08:00",
                "size": 3285099,
                "metadata": {
                    "thumb:disabled": ""
                },
                "path": "cloudreve://my/Luke's%20AMA/%E5%B0%8F%E7%88%B1%E8%B1%86.psd",
                "capability": "39/9",
                "owned": true,
                "primary_entity": "jYOAc8"
            }
        ],
        "parent": {
            "type": 1,
            "id": "0OmpAGUn",
            "name": "Luke's AMA",
            "permission": null,
            "created_at": "2024-01-27T10:58:20+08:00",
            "updated_at": "2025-05-23T15:09:15+08:00",
            "size": 0,
            "metadata": null,
            "path": "cloudreve://my/Luke's%20AMA",
            "capability": "39/9",
            "owned": true,
            "primary_entity": "zOie"
        },
        "pagination": {
            "page": 0,
            "page_size": 100,
            "is_cursor": true
        },
        "props": {
            "capability": "39/9",
            "max_page_size": 2000,
            "order_by_options": [
                "name",
                "size",
                "updated_at",
                "created_at"
            ],
            "order_direction_options": [
                "asc",
                "desc"
            ]
        },
        "context_hint": "5c6ea8a1-86e0-4967-8d40-598c6eb78bff",
        "mixed_type": false,
        "storage_policy": {
            "id": "Emta",
            "name": "minio",
            "type": "s3",
            "max_size": 0
        }
    },
    "msg": ""
}
修改于 2025-10-11 12:40:12
上一页
删除直链
下一页
列出文件活动
Built with