Send reset password email

POST

/user/reset

Auth: None

Send a email for an existing account to reset the password.

Request

Body Params application/json

captcha

string | null

optional

User input value of the graphical CAPTCHA. Required if graphic CAPTCHA enabled for current action.

Example:

z3ds

ticket

string | null

optional

Ticket/Token of the CAPTCHA. Required if CAPTCHA is enabled for current action. Can be obtained from Get CAPTCHA.

Example:

4qXv7KmbYajJ0yFDKcmJ

string <email>

required

Account ematil.

Example:

example@cloudreve.org

Example

{
    "captcha": "z3ds",
    "ticket": "4qXv7KmbYajJ0yFDKcmJ",
    "email": "example@cloudreve.org"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/user/reset' \
--header 'Content-Type: application/json' \
--data-raw '{
    "captcha": "z3ds",
    "ticket": "4qXv7KmbYajJ0yFDKcmJ",
    "email": "example@cloudreve.org"
}'

Responses

🟢200Success

application/json

Body

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,
    "msg": ""
}

Modified at 2025-04-26 08:47:09

Reset password via temp link