Cloudreve API Docs
    • README
    • 站点信息
      • 健康检查
      • 获取验证码
      • 获取站点设置
      • 举报滥用
    • 会话管理
      • 令牌
        • 密码登录
        • 完成双因素认证登录
        • 刷新令牌
        • 退出登录
      • 开放ID
        • 准备OpenID登录
        • 完成OpenID登录
        • 解绑OpenID
      • 通行密钥
        • 准备通行密钥登录
        • 完成通行密钥登录
      • 准备登录
    • 用户管理
      • 通行密钥
        • 准备通行密钥注册
        • 完成通行密钥注册
        • 删除通行密钥
      • 设置
        • 列出可用存储策略
        • 列出可用节点
        • 获取偏好设置
        • 准备启用双因素认证
        • 更新偏好设置
        • 更新头像
      • 用户注册
      • 发送密码重置邮件
      • 通过临时链接重置密码
      • 获取头像
      • 获取用户信息
      • 列出用户的分享链接
      • 获取存储容量
      • 搜索用户
      • 列出积分变更记录
      • 列出支付记录
    • 回调
      • 完成OBS上传
      • 完成OneDrive上传
      • 完成COS上传
      • 完成S3上传
    • 工作流
      • 远程下载
        • 创建远程下载
        • 选择要下载的文件
        • 取消任务
      • 列出任务
      • 获取任务进度
      • 创建压缩包
      • 提取压缩包
      • 重新定位存储策略
      • 导入外部文件
    • 文件管理
      • 权限管理
        • 设置权限
        • 删除权限设置
      • 上传
        • 创建上传会话
        • 上传文件分块
        • 删除上传会话
      • 固定项
        • 固定到侧边栏
        • 删除固定项
      • 版本管理
        • 设置文件版本
        • 删除文件版本
      • 直链管理
        • 创建直链
        • 删除直链
      • 列出文件
      • 列出文件活动
      • 获取文件信息
      • 获取缩略图URL
      • 获取压缩包文件列表
      • 更新文件内容
      • 创建查看器会话
      • 创建文件
      • 重命名文件
      • 移动或复制文件
      • 创建下载URL
      • 从回收站恢复
      • 删除文件
      • 强制解锁
      • 修补元数据
      • 挂载存储策略
      • 更新视图设置
    • 分享管理
      • 创建分享链接
      • 编辑分享链接
      • 获取分享链接信息
      • 列出我的分享链接
      • 删除分享链接
    • 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

    ListResponse

    {
        "files": [
            {
                "type": 0,
                "id": "string",
                "name": "btn_google_signin_dark_normal_web@2x.png",
                "permission": "string",
                "created_at": "2025-05-24T10:55:22+08:00",
                "updated_at": "2025-05-24T10:55:22+08:00",
                "size": 7536,
                "metadata": {
                    "property1": "string",
                    "property2": "string"
                },
                "path": "cloudreve://my/%E9%97%A8%E7%A5%A8/btn_google_signin_dark_normal_web%402x.png",
                "shared": true,
                "capability": "39/9",
                "owned": true,
                "primary_entity": "string",
                "extended_info": {
                    "storage_policy": {
                        "id": "96u1",
                        "name": "Default storage policy",
                        "allowed_suffix": [
                            "jpg"
                        ],
                        "denied_suffix": [
                            "string"
                        ],
                        "type": "local",
                        "allowed_name_regexp": "string",
                        "denied_name_regexp": "string",
                        "max_size": 0,
                        "relay": true,
                        "weight": 0,
                        "children": [
                            {}
                        ],
                        "chunk_concurrency": 0
                    },
                    "storage_policy_inherited": true,
                    "storage_used": 331469,
                    "shares": [
                        {
                            "id": "VoMFL",
                            "name": "Shared folder",
                            "visited": 776,
                            "downloaded": 0,
                            "price": 999,
                            "unlocked": true,
                            "source_type": 1,
                            "owner": {
                                "id": "6JIo",
                                "email": "string",
                                "nickname": "Johnny Zhang",
                                "created_at": "2023-08-06T19:21:59+08:00",
                                "group": {
                                    "id": "1AI8",
                                    "name": "Admin",
                                    "permission": "/f8B",
                                    "direct_link_batch_size": 10,
                                    "trash_retention": 864000
                                },
                                "disable_view_sync": "string",
                                "share_links_in_profile": "[Empty string]"
                            },
                            "created_at": "2019-08-24T14:15:22.123Z",
                            "expired": true,
                            "url": "http://cloudreve.org/s/VoMFL/2rje2bdj",
                            "permission_setting": {
                                "same_group": null,
                                "everyone": "string",
                                "other": null,
                                "anonymous": "string",
                                "group_explicit": {},
                                "user_explicit": {}
                            },
                            "is_private": true,
                            "password": "2rje2bdj",
                            "source_uri": "cloudreve://lpua@my/BrNJdjbgi1mvqBf7zycSCskw6ky8nle0",
                            "share_view": true,
                            "show_readme": true,
                            "password_protected": true
                        }
                    ],
                    "entities": [
                        {
                            "id": "OlNQfZ",
                            "size": 323595,
                            "type": 0,
                            "created_at": "2025-05-24T02:31:17+08:00",
                            "storage_policy": {
                                "id": "96u1",
                                "name": "Default storage policy",
                                "allowed_suffix": [
                                    "jpg"
                                ],
                                "denied_suffix": [
                                    "string"
                                ],
                                "type": "local",
                                "allowed_name_regexp": "string",
                                "denied_name_regexp": "string",
                                "max_size": 0,
                                "relay": true,
                                "weight": 0,
                                "children": [
                                    {}
                                ],
                                "chunk_concurrency": 0
                            },
                            "created_by": {
                                "id": "6JIo",
                                "email": "string",
                                "nickname": "Johnny Zhang",
                                "created_at": "2023-08-06T19:21:59+08:00",
                                "group": {
                                    "id": "1AI8",
                                    "name": "Admin"
                                },
                                "avatar": "file",
                                "disable_view_sync": "string",
                                "share_links_in_profile": "[Empty string]"
                            }
                        }
                    ],
                    "permissions": {
                        "user_explicit": {
                            "property1": "AQ==",
                            "property2": "AQ=="
                        },
                        "group_explicit": {
                            "property1": "AQ==",
                            "property2": "AQ=="
                        },
                        "same_group": "string",
                        "other": "string",
                        "anonymous": "AQ==",
                        "everyone": "AQ=="
                    },
                    "direct_links": [
                        {
                            "id": "xMxIa",
                            "url": "http://localhost:5173/f/xMxIa/New%20file.excalidraw",
                            "downloaded": 0,
                            "created_at": "2025-06-26T17:55:30+08:00"
                        }
                    ]
                },
                "folder_summary": {
                    "size": 8001,
                    "files": 3,
                    "folders": 1,
                    "completed": true,
                    "calculated_at": "2025-05-24T11:02:43.086056909+08:00"
                }
            }
        ],
        "parent": {
            "type": 0,
            "id": "string",
            "name": "btn_google_signin_dark_normal_web@2x.png",
            "permission": "string",
            "created_at": "2025-05-24T10:55:22+08:00",
            "updated_at": "2025-05-24T10:55:22+08:00",
            "size": 7536,
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "path": "cloudreve://my/%E9%97%A8%E7%A5%A8/btn_google_signin_dark_normal_web%402x.png",
            "shared": true,
            "capability": "39/9",
            "owned": true,
            "primary_entity": "string",
            "extended_info": {
                "storage_policy": {
                    "id": "96u1",
                    "name": "Default storage policy",
                    "allowed_suffix": [
                        "jpg"
                    ],
                    "denied_suffix": [
                        "string"
                    ],
                    "type": "local",
                    "allowed_name_regexp": "string",
                    "denied_name_regexp": "string",
                    "max_size": 0,
                    "relay": true,
                    "weight": 0,
                    "children": [
                        {}
                    ],
                    "chunk_concurrency": 0
                },
                "storage_policy_inherited": true,
                "storage_used": 331469,
                "shares": [
                    {
                        "id": "VoMFL",
                        "name": "Shared folder",
                        "visited": 776,
                        "downloaded": 0,
                        "price": 999,
                        "unlocked": true,
                        "source_type": 1,
                        "owner": {
                            "id": "6JIo",
                            "email": "string",
                            "nickname": "Johnny Zhang",
                            "created_at": "2023-08-06T19:21:59+08:00",
                            "group": {
                                "id": "1AI8",
                                "name": "Admin",
                                "permission": "/f8B",
                                "direct_link_batch_size": 10,
                                "trash_retention": 864000
                            },
                            "disable_view_sync": "string",
                            "share_links_in_profile": "[Empty string]"
                        },
                        "created_at": "2019-08-24T14:15:22.123Z",
                        "expired": true,
                        "url": "http://cloudreve.org/s/VoMFL/2rje2bdj",
                        "permission_setting": {
                            "same_group": null,
                            "everyone": "string",
                            "other": null,
                            "anonymous": "string",
                            "group_explicit": {},
                            "user_explicit": {}
                        },
                        "is_private": true,
                        "password": "2rje2bdj",
                        "source_uri": "cloudreve://lpua@my/BrNJdjbgi1mvqBf7zycSCskw6ky8nle0",
                        "share_view": true,
                        "show_readme": true,
                        "password_protected": true
                    }
                ],
                "entities": [
                    {
                        "id": "OlNQfZ",
                        "size": 323595,
                        "type": 0,
                        "created_at": "2025-05-24T02:31:17+08:00",
                        "storage_policy": {
                            "id": "96u1",
                            "name": "Default storage policy",
                            "allowed_suffix": [
                                "jpg"
                            ],
                            "denied_suffix": [
                                "string"
                            ],
                            "type": "local",
                            "allowed_name_regexp": "string",
                            "denied_name_regexp": "string",
                            "max_size": 0,
                            "relay": true,
                            "weight": 0,
                            "children": [
                                {}
                            ],
                            "chunk_concurrency": 0
                        },
                        "created_by": {
                            "id": "6JIo",
                            "email": "string",
                            "nickname": "Johnny Zhang",
                            "created_at": "2023-08-06T19:21:59+08:00",
                            "group": {
                                "id": "1AI8",
                                "name": "Admin"
                            },
                            "avatar": "file",
                            "disable_view_sync": "string",
                            "share_links_in_profile": "[Empty string]"
                        }
                    }
                ],
                "permissions": {
                    "user_explicit": {
                        "property1": "AQ==",
                        "property2": "AQ=="
                    },
                    "group_explicit": {
                        "property1": "AQ==",
                        "property2": "AQ=="
                    },
                    "same_group": "string",
                    "other": "string",
                    "anonymous": "AQ==",
                    "everyone": "AQ=="
                },
                "direct_links": [
                    {
                        "id": "xMxIa",
                        "url": "http://localhost:5173/f/xMxIa/New%20file.excalidraw",
                        "downloaded": 0,
                        "created_at": "2025-06-26T17:55:30+08:00"
                    }
                ]
            },
            "folder_summary": {
                "size": 8001,
                "files": 3,
                "folders": 1,
                "completed": true,
                "calculated_at": "2025-05-24T11:02:43.086056909+08:00"
            }
        },
        "pagination": {
            "page": 1,
            "page_size": 50,
            "total_items": 5664,
            "next_token": "eyJpZCI6Inh4cUR1QSJ9",
            "is_cursor": true
        },
        "props": {
            "capability": "39/9",
            "max_page_size": 2000,
            "order_by_options": [
                "name"
            ],
            "order_direction_options": [
                "asc"
            ]
        },
        "context_hint": "4008c479-0e1b-409b-950d-e12fd8003fb0",
        "recursion_limit_reached": true,
        "mixed_type": true,
        "single_file_view": true,
        "storage_policy": {
            "id": "96u1",
            "name": "Default storage policy",
            "allowed_suffix": [
                "jpg"
            ],
            "denied_suffix": [
                "string"
            ],
            "type": "local",
            "allowed_name_regexp": "string",
            "denied_name_regexp": "string",
            "max_size": 0,
            "relay": true,
            "weight": 0,
            "children": [
                {}
            ],
            "chunk_concurrency": 0
        },
        "view": {
            "page_size": 50,
            "order": "string",
            "order_direction": "asc",
            "view": "list",
            "thumbnail": true,
            "gallery_width": 50,
            "columns": [
                {
                    "type": 0,
                    "width": 0,
                    "props": {
                        "metadata_key": "string"
                    }
                }
            ]
        }
    }
    Built with