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

    SiteConfig

    {
        "instance_id": "string",
        "title": "string",
        "login_captcha": true,
        "reg_captcha": true,
        "forget_captcha": true,
        "abuse_report_captcha": true,
        "themes": "{\"#3f51b5\":{\"light\":{\"palette\":{\"primary\":{\"main\":\"#3f51b5\"},\"secondary\":{\"main\":\"#f50057\"}}},\"dark\":{\"palette\":{\"primary\":{\"main\":\"#9fa8da\"},\"secondary\":{\"main\":\"#ff4081\"}}}},\"#722946\":{\"light\":{\"palette\":{\"primary\":{\"main\":\"#722946\"},\"secondary\":{\"main\":\"#f50057\"}}},\"dark\":{\"palette\":{\"primary\":{\"main\":\"#e17fa5\"},\"secondary\":{\"main\":\"#f50057\"}}}},\"#1976d2\":{\"light\":{\"palette\":{\"primary\":{\"main\":\"#1976d2\",\"light\":\"#42a5f5\",\"dark\":\"#1565c0\"},\"secondary\":{\"main\":\"#9c27b0\",\"light\":\"#ba68c8\",\"dark\":\"#7b1fa2\"}}},\"dark\":{\"palette\":{\"primary\":{\"main\":\"#90caf9\",\"light\":\"#e3f2fd\",\"dark\":\"#42a5f5\"},\"secondary\":{\"main\":\"#ce93d8\",\"light\":\"#f3e5f5\",\"dark\":\"#ab47bc\"}}}}}",
        "default_theme": "string",
        "authn": true,
        "user": {
            "id": "6JIo",
            "email": "string",
            "nickname": "Johnny Zhang",
            "created_at": "2023-08-06T19:21:59+08:00",
            "anonymous": true,
            "group": {
                "id": "1AI8",
                "name": "Admin",
                "permission": "/f8B",
                "direct_link_batch_size": 10,
                "trash_retention": 864000
            },
            "status": "active",
            "avatar": "file",
            "preferred_theme": "#131313",
            "credit": 0,
            "language": "en-US",
            "disable_view_sync": "string",
            "share_links_in_profile": "[Empty string]"
        },
        "captcha_ReCaptchaKey": "string",
        "captcha_cap_instance_url": "string",
        "captcha_cap_site_key": "string",
        "site_notice": "string",
        "captcha_type": "normal",
        "turnstile_site_id": "string",
        "register_enabled": true,
        "qq_enabled": true,
        "sso_enabled": true,
        "sso_display_name": "vas.sso",
        "sso_icon": "string",
        "oidc_enabled": true,
        "oidc_display_name": "string",
        "oidc_icon": "string",
        "logo": "/static/img/logo.svg",
        "logo_light": "/static/img/logo_light.svg",
        "tos_url": "string",
        "privacy_policy_url": "string",
        "icons": "[{\"exts\":[\"mp3\",\"flac\",\"ape\",\"wav\",\"acc\",\"ogg\",\"m4a\"],\"icon\":\"audio\",\"color\":\"#651fff\"},{\"exts\":[\"mp4\",\"flv\",\"avi\",\"wmv\",\"mkv\",\"rm\",\"rmvb\",\"mov\",\"ogv\",\"m3u8\"],\"icon\":\"video\",\"color\":\"#d50000\"},{\"exts\":[\"bmp\",\"iff\",\"png\",\"gif\",\"jpg\",\"jpeg\",\"psd\",\"svg\",\"webp\",\"heif\",\"heic\",\"tiff\",\"avif\"],\"icon\":\"image\",\"color\":\"#d32f2f\"},{\"exts\":[\"3fr\",\"ari\",\"arw\",\"bay\",\"braw\",\"crw\",\"cr2\",\"cr3\",\"cap\",\"dcs\",\"dcr\",\"dng\",\"drf\",\"eip\",\"erf\",\"fff\",\"gpr\",\"iiq\",\"k25\",\"kdc\",\"mdc\",\"mef\",\"mos\",\"mrw\",\"nef\",\"nrw\",\"obm\",\"orf\",\"pef\",\"ptx\",\"pxn\",\"r3d\",\"raf\",\"raw\",\"rwl\",\"rw2\",\"rwz\",\"sr2\",\"srf\",\"srw\",\"tif\",\"x3f\"],\"icon\":\"raw\",\"color\":\"#d32f2f\"},{\"exts\":[\"pdf\"],\"color\":\"#f44336\",\"icon\":\"pdf\"},{\"exts\":[\"doc\",\"docx\"],\"color\":\"#538ce5\",\"icon\":\"word\"},{\"exts\":[\"ppt\",\"pptx\"],\"color\":\"#EF633F\",\"icon\":\"ppt\"},{\"exts\":[\"xls\",\"xlsx\",\"csv\"],\"color\":\"#4caf50\",\"icon\":\"excel\"},{\"exts\":[\"txt\",\"html\"],\"color\":\"#607d8b\",\"icon\":\"text\"},{\"exts\":[\"torrent\"],\"color\":\"#5c6bc0\",\"icon\":\"torrent\"},{\"exts\":[\"zip\",\"gz\",\"xz\",\"tar\",\"rar\",\"7z\",\"bz2\",\"z\"],\"color\":\"#f9a825\",\"icon\":\"zip\"},{\"exts\":[\"exe\",\"msi\"],\"color\":\"#1a237e\",\"icon\":\"exe\"},{\"exts\":[\"apk\"],\"color\":\"#8bc34a\",\"icon\":\"android\"},{\"exts\":[\"go\"],\"color\":\"#16b3da\",\"icon\":\"go\"},{\"exts\":[\"py\"],\"color\":\"#3776ab\",\"icon\":\"python\"},{\"exts\":[\"c\"],\"color\":\"#a4c639\",\"icon\":\"c\"},{\"exts\":[\"cpp\"],\"color\":\"#f34b7d\",\"icon\":\"cpp\"},{\"exts\":[\"js\",\"jsx\"],\"color\":\"#f4d003\",\"icon\":\"js\"},{\"exts\":[\"epub\"],\"color\":\"#81b315\",\"icon\":\"book\"},{\"exts\":[\"rs\"],\"color\":\"#000\",\"color_dark\":\"#fff\",\"icon\":\"rust\"},{\"exts\":[\"drawio\"],\"color\":\"#F08705\",\"icon\":\"flowchart\"},{\"exts\":[\"dwb\"],\"color\":\"#F08705\",\"icon\":\"whiteboard\"},{\"exts\":[\"md\"],\"color\":\"#383838\",\"color_dark\":\"#cbcbcb\",\"icon\":\"markdown\"},{\"exts\":[\"so\"],\"img\":\"https://cdn.sstatic.net/Img/teams/teams-illo-free-sidebar-promo.svg\"},{\"img\":\"https://dscache.tencent-cloud.cn/upload//%E5%AE%98%E7%BD%91%E4%BE%A7%E8%BE%B9_%E9%99%90%E6%97%B6%E7%A7%92%E6%9D%80-de2107c547c0ee4e372a829c800caaa540abcda8.png\",\"exts\":[\"123\"]},{\"img\":\"https://www.nekodrive.net/images/client_icons/filetypes_icons/asp.svg\",\"exts\":[\"asp\"]},{\"img\":\"https://cdn.sstatic.net/Img/teams/teams-promo.svg?v=e507948b81bf\",\"exts\":[\"aspx\"]}]",
        "emoji_preset": "{\"😀\":[\"😀\"]}",
        "point_enabled": true,
        "share_point_gain_rate": 80,
        "map_provider": "google",
        "google_map_tile_type": "terrain",
        "file_viewers": [
            {
                "viewers": [
                    {
                        "id": "string",
                        "type": "string",
                        "display_name": "builtin",
                        "exts": [
                            "jpg"
                        ],
                        "icon": "string",
                        "max_size": 0,
                        "url": "string"
                    }
                ]
            }
        ],
        "max_batch_size": 0,
        "app_promotion": true,
        "app_feedback": "string",
        "app_forum": "string",
        "payment": {
            "currency_code": "USD",
            "currency_mark": "$",
            "currency_unit": 100,
            "providers": [
                {
                    "id": "8ff2cceb-b4e6-4fa8-a934-04900a2e8699",
                    "type": "stripe",
                    "name": "string"
                }
            ]
        },
        "anonymous_purchase": true,
        "point_price": 10,
        "shop_nav_enabled": true,
        "storage_products": [
            {
                "id": "ea602ab6-bd1e-40c3-b674-bef18fda7fa9",
                "name": "Prenimum Storage",
                "size": 0,
                "time": 2592000,
                "price": 1000,
                "chip": "Recomended",
                "points": 10000
            }
        ],
        "group_skus": [
            {
                "id": "string",
                "name": "string",
                "time": 0,
                "price": 0,
                "chip": "string",
                "points": 0,
                "des": [
                    "string"
                ]
            }
        ],
        "thumbnail_width": 0,
        "thumbnail_height": 0,
        "custom_props": [
            {
                "id": "department",
                "name": "Department",
                "type": "text",
                "max": "string",
                "min": "string",
                "default": "string",
                "options": [
                    "string"
                ],
                "icon": "fluent:organization-24-filled"
            }
        ],
        "custom_nav_items": [
            {
                "icon": "fluent:comment-multiple-24-regular",
                "name": "Get help",
                "url": "string",
                "": "string"
            }
        ],
        "custom_html": {
            "headless_footer": "string",
            "headless_bottom": "string",
            "sidebar_bottom": "string"
        }
    }
    Built with