Get site settings

Get global site settings paritioned by sections. Only settings in your requested section will be included in your response.

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

data

object (SiteConfig)

required

Response content

instance_id

string | null

optional

Unique UUID of the Cloudreve instance.

title

string | null

optional

Name of the site.

login_captcha

boolean | null

optional

Whether CPATCHA is required for sign in request.

reg_captcha

boolean | null

optional

Whether CPATCHA is required for sign up request.

forget_captcha

boolean | null

optional

Whether CPATCHA is required for resettinig password request.

themes

string | null

optional

JSON encoded theme options.

Example:

{"#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 | null

optional

Primary color of the global default theme.

authn

boolean | null

optional

Whether Passkey is enabled.

user

optional

Current logined user.

captcha_ReCaptchaKey

string | null

optional

Site key of Google reCaptcha (if configured).

site_notice

string | null

optional

Global site announcement (if configured).

captcha_type

enum<string> | enum<null>

optional

Provider type of the captcha.

Allowed values:

normalrecaptchaturnstile

turnstile_site_id

string | null

optional

Cloudflare Turnstile Site ID (if configured).

register_enabled

boolean | null

optional

Whether this site allowing new user sign up.

qq_enabled

boolean | null

optional

Whether sign in via Tencent QQ is enabled.

sso_enabled

boolean | null

optional

Whether sign in via Logto is enabled.

sso_display_name

string | null

optional

Display name of the Logto sign method, may be i18next key.

Example:

vas.sso

logo

string | null

optional

URL of the logo image for light mode.

Example:

/static/img/logo.svg

logo_light

string | null

optional

URL of the logo image for dark mode.

Example:

/static/img/logo_light.svg

tos_url

string | null

optional

URL of the document for term of serivce.

privacy_policy_url

string | null

optional

URL of the document for privacy policy.

icons

string | null

optional

JSON encoded file icons map.

Example:

[{"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

string | null

optional

JSON encoded emoji preset for customizing file icons.

Example:

{"😀":["😀"]}

point_enabled

boolean | null

optional

Whether credit(points) feature is enabled.

share_point_gain_rate

number | null

optional

Percentage of share owner's commission rate.

>= 1<= 100

Example:

Multiple of:

map_provider

enum<string> | enum<null>

optional

Map provider.

Allowed values:

googleopenstreetmap

google_map_tile_type

enum<string> | enum<null>

optional

Google map tile type.

Allowed values:

terrainsatellitenormal

file_viewers

array [anyOf] | null

optional

List of file app groups.

max_batch_size

number | null

optional

The maximum number of files in a batch operation.

app_promotion

boolean | null

optional

Whether to show promotion page.

app_feedback

string | null

optional

Feedback URL for mobile APP.

app_forum

string | null

optional

Forum URL for mobile APP.

payment

optional

Payment settings.

anonymous_purchase

boolean | null

optional

Whether to allow non-logged-in users to purchase share links directly.

point_price

number | null

optional

Price for recharging credit points with money (in minimum currency unit). Fill 0 to disable credit recharge.

Example:

shop_nav_enabled

boolean | null

optional

Whether to display 'Shop' items in the sidebar navigation.

storage_products

array [anyOf] | null

optional

Available storage product SKUs.

group_skus

array [anyOf] | null

optional

Available membership SKUs.

thumbnail_width

number | null

optional

Max width of file thumbnails.

thumbnail_height

number | null

optional

Max height of file thumbnails.

code

integer

required

Response code.
0 - Success.

Default:

Example:

msg

string

optional

Human readable error message (if any).

error

string | null

optional

Internal error message, only visable in debug mode.

correlation_id

string <uuid> | null

optional

Correlation ID of the request. Only presented on failed reqeust.

Example:

b4351ecc-ee1a-4455-bc94-2c3dbcc58538

Example

{
  "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": ""
}

Request

Request samples

Responses