Create account - Cloudreve API Docs

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Body Params application/json

uri

string

required

URI of the relative root folder.

name

string

required

Annotation of the account.

>= 1 characters<= 255 characters

readonly

boolean | null

optional

Whether this account is readonly.

proxy

boolean | null

optional

Whether reverse proxy is enabled for this account.

Example

{
    "name": "new account",
    "uri": "cloudreve://my/0",
    "proxy": true,
    "readonly": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT '/devices/dav' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "new account",
    "uri": "cloudreve://my/0",
    "proxy": true,
    "readonly": true
}'

Responses

🟢200Success

application/json

Body

data

object (DavAccount)

required

id

string

required

ID of the WebDAV account.

Example:

WNuO

created_at

string <date-time>

required

Datetime when the account is created.

Example:

2023-12-04T18:51:42+08:00

name

string

required

Annotation of this account.

Example:

My account

uri

string

required

URI of the root folder.

Example:

cloudreve://my

password

string

required

Generated password of this account.

Example:

f6zxgh7j4yo3vuvtdpcxd6na89efvmpo

options

string

required

Boolset encoded account options.

code

integer

required

Response code.
0 - Success.

Default:

0

Example:

0

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": {
        "id": "YnCp",
        "created_at": "2025-06-13T13:43:14.421686+08:00",
        "name": "new account",
        "uri": "cloudreve://my/0",
        "password": "kkf138mdipcwghkodndepu6sjasn9q0j",
        "options": "Aw=="
    },
    "msg": ""
}