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

获取站点设置

GET
/site/config/{section}
按部分获取全局站点设置。只有您请求的部分中的设置将包含在您的响应中。

请求参数

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

返回响应

🟢200Success
application/json
Bodyapplication/json

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location '/site/config/basic' \
--header 'Authorization: Bearer <token>'
响应示例响应示例
{
    "code": 0,
    "data": {
        "instance_id": "ac748bd0-7a04-48e7-a12b-8b3b9184b908",
        "title": "Cloudreve",
        "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": "#1976d2",
        "site_notice": "This is a test site",
        "user": {
            "id": "6JIo",
            "email": "johnny.z@cloudreve.org",
            "nickname": "Johnny Zhang",
            "status": "active",
            "avatar": "file",
            "created_at": "2023-08-06T19:21:59+08:00",
            "credit": 2000,
            "group": {
                "id": "1AI8",
                "name": "User",
                "permission": "/GY=",
                "direct_link_batch_size": 10,
                "trash_retention": 14400
            },
            "pined": [
                {
                    "uri": "cloudreve://my/videos"
                }
            ]
        },
        "logo": "/static/img/logo.svg",
        "logo_light": "/static/img/logo_light.svg",
        "shop_nav_enabled": true,
        "captcha_ReCaptchaKey": "6Lel1OgUAAAAABCVuOIduv0dKsrAZnsQeemPZayd",
        "captcha_type": "turnstile",
        "turnstile_site_id": "0x4AAAAAAA9Te1sevTpZkzvy",
        "app_promotion": true
    },
    "msg": ""
}
修改于 2025-10-11 12:40:12
上一页
获取验证码
下一页
举报滥用
Built with