站点信息 - 社区版API

请求参数

Cookie 参数

cloudreve-session

string

鉴权session

可选

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://127.0.0.1:5212/api/v3/site/config?members&reference&Type&_postman_listIndexKey=key&_postman_listAllowsMultipleValues'

返回响应

🟢200成功

application/json

Body

code

integer

响应状态

必需

data

object

必需

title

string

站点标题

必需

loginCaptcha

boolean

登录需要人机验证

必需

regCaptcha

boolean

注册需要人机验证

必需

forgetCaptcha

boolean

必需

重置密码需要人机验证

emailActive

boolean

注册需要邮件验证

必需

themes

string

主题

必需

defaultTheme

string

默认主题

必需

home_view_method

string

主页展示模式

必需

share_view_method

string

分享展示模式

必需

authn

boolean

必需

user

object (User)

当前登录的用户信息

必需

captcha_ReCaptchaKey

string

必需

ReCaptcha API Key

captcha_type

enum<string>

使用的人机验证类型

必需

枚举值:

normalrecaptchatcaptcha

tcaptcha_captcha_app_id

string

必需

tcaptcha API Key

registerEnabled

boolean

允许用户注册

必需

app_promotion

boolean

必需

wopi_exts

null

必需

msg

string

错误信息

必需

示例

{
  "code": 0,
  "data": {
    "title": "Cloudreve",
    "loginCaptcha": false,
    "regCaptcha": false,
    "forgetCaptcha": false,
    "emailActive": false,
    "themes": "{\"#3f51b5\":{\"palette\":{\"primary\":{\"main\":\"#3f51b5\"},\"secondary\":{\"main\":\"#f50057\"}}},\"#2196f3\":{\"palette\":{\"primary\":{\"main\":\"#2196f3\"},\"secondary\":{\"main\":\"#FFC107\"}}},\"#673AB7\":{\"palette\":{\"primary\":{\"main\":\"#673AB7\"},\"secondary\":{\"main\":\"#2196F3\"}}},\"#E91E63\":{\"palette\":{\"primary\":{\"main\":\"#E91E63\"},\"secondary\":{\"main\":\"#42A5F5\",\"contrastText\":\"#fff\"}}},\"#FF5722\":{\"palette\":{\"primary\":{\"main\":\"#FF5722\"},\"secondary\":{\"main\":\"#3F51B5\"}}},\"#FFC107\":{\"palette\":{\"primary\":{\"main\":\"#FFC107\"},\"secondary\":{\"main\":\"#26C6DA\"}}},\"#8BC34A\":{\"palette\":{\"primary\":{\"main\":\"#8BC34A\",\"contrastText\":\"#fff\"},\"secondary\":{\"main\":\"#FF8A65\",\"contrastText\":\"#fff\"}}},\"#009688\":{\"palette\":{\"primary\":{\"main\":\"#009688\"},\"secondary\":{\"main\":\"#4DD0E1\",\"contrastText\":\"#fff\"}}},\"#607D8B\":{\"palette\":{\"primary\":{\"main\":\"#607D8B\"},\"secondary\":{\"main\":\"#F06292\"}}},\"#795548\":{\"palette\":{\"primary\":{\"main\":\"#795548\"},\"secondary\":{\"main\":\"#4CAF50\",\"contrastText\":\"#fff\"}}}}",
    "defaultTheme": "#3f51b5",
    "home_view_method": "icon",
    "share_view_method": "list",
    "authn": false,
    "user": {
      "id": "l6hY",
      "user_name": "admin@cloudreve.org",
      "nickname": "admin",
      "status": 0,
      "avatar": "",
      "created_at": "2024-05-01T11:04:25.490486+08:00",
      "preferred_theme": "",
      "anonymous": false,
      "group": {
        "id": 1,
        "name": "Admin",
        "allowShare": true,
        "allowRemoteDownload": true,
        "allowArchiveDownload": true,
        "shareDownload": true,
        "compress": true,
        "webdav": true,
        "sourceBatch": 1000,
        "advanceDelete": true,
        "allowWebDAVProxy": false
      },
      "tags": []
    },
    "captcha_ReCaptchaKey": "defaultKey",
    "captcha_type": "normal",
    "tcaptcha_captcha_app_id": "",
    "registerEnabled": true,
    "app_promotion": true,
    "wopi_exts": null
  },
  "msg": ""
}