Cloudreve API Docs
  1. Setting
Cloudreve API Docs
  • Site
    • Ping
      GET
    • Get CAPTCHA
      GET
    • Get site settings
      GET
    • Report abuse
      POST
  • Session
    • Token
      • Password sign-in
      • Finish sign-in with 2FA
      • Refresh Token
      • Sign out
    • OpenID
      • Prepare OpenID sign-in
      • Finish OpenID sign-in
      • Unlink OpenID
    • Passkey
      • Prepare Passkey sign-in
      • Finish Passkey sign-in
    • Prepare login
      GET
  • User
    • Passkey
      • Prepare passkey registration
      • Finish passkey registration
      • Delete passkey
    • Setting
      • List available storage policies
        GET
      • List available nodes
        GET
      • Get preferences
        GET
      • Prepare enabling 2FA
        GET
      • Update preference setting
        PATCH
      • Update profile pricture
        PUT
    • Sign up
      POST
    • Send reset password email
      POST
    • Reset password via temp link
      PATCH
    • Get profile picture
      GET
    • Get user
      GET
    • List user's share links
      GET
    • Get storage capacity
      GET
    • Search user
      GET
    • List credit changes
      GET
    • List payments
      GET
  • Callback
    • Complete OBS upload
    • Complete OneDrive upload
    • Complete COS upload
    • Complete S3 upload
  • Workflow
    • Remote Download
      • Create remote download
      • Select files to download
      • Cancel task
    • List tasks
    • Get task progress
    • Create archive
    • Extract archive
    • Relocate storage policy
    • Import external files
  • File
    • Permission
      • Set permission
      • Delete permission setting
    • Upload
      • Create upload session
      • Upload file chunk
      • Delete upload session
    • Pin
      • Pin to sidebar
      • Delete a pin
    • Version
      • Set file version
      • Delete file version
    • Direct Link
      • Create direct links
      • Delete direct link
    • List files
    • List file activities
    • Get file info
    • Get thumbnail URL
    • Update file content
    • Create viewer session
    • Create file
    • Rename file
    • Move or copy files
    • Create download URL
    • Restore from trash bin
    • Delete file
    • Force unlock
    • Patch metadata
    • Mount storage policy
    • Update view setting
  • Share
    • Create share link
    • Edit share link
    • Get share link info
    • List my share links
    • Delete share link
  • VAS
    • Payment
      • Create a payment
      • Get payment status
    • GiftCode
      • Check gift code
      • Redeem gift code
  • Group
    • List groups
  • WebDAV
    • List accounts
    • Create account
    • Update account
    • Delete account
  1. Setting

Get preferences

GET
/user/setting

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/user/setting'

Responses

🟢200Success
application/json
Body

Example
{
    "code": 0,
    "data": {
        "open_id": [
            {
                "provider": 0,
                "linked_at": "2025-04-10T20:04:19+08:00"
            }
        ],
        "version_retention_enabled": true,
        "version_retention_max": 5,
        "passwordless": false,
        "two_fa_enabled": false,
        "passkeys": [
            {
                "id": "oQK4yEBXSeONnJJLN+GMkA==",
                "name": "Chrome on Mac OS X",
                "used_at": "2025-05-23T16:43:29+08:00",
                "created_at": "2025-05-23T16:43:10+08:00"
            }
        ],
        "login_activity": [
            {
                "created_at": "2025-06-12T09:24:19+08:00",
                "ip": "::1",
                "browser": "Safari",
                "device": "Mac",
                "os": "Mac OS X",
                "login_with": "",
                "open_id_provider": 0,
                "success": true,
                "webdav": false
            },
            {
                "created_at": "2025-04-01T16:46:16+08:00",
                "ip": "::1",
                "browser": "Chrome",
                "device": "Mac",
                "os": "Mac OS X",
                "login_with": "",
                "open_id_provider": 0,
                "success": false,
                "webdav": false
            }
        ],
        "storage_packs": [
            {
                "name": "Unlimited Storage",
                "active_since": "2025-03-20T17:52:20+08:00",
                "expire_at": "2026-03-20T17:52:20+08:00",
                "size": 214748364800
            }
        ],
        "credit": 24600,
        "disable_view_sync": false
    },
    "msg": ""
}
Modified at 2025-08-12 07:34:18
Previous
List available nodes
Next
Prepare enabling 2FA
Built with