Ask for a password reset link

POST

/api/v1/public/password-reset

curl --request POST \
  --url https://api.deploybase.eu/api/v1/api/v1/public/password-reset \
  --header 'Content-Type: application/json' \
  --data '{ "email": "sam@example.eu" }'

Mails a reset link to the address if it has an account. Answers 202 with the same body whether or not it does; the lookup and the mail happen after the answer. No authentication required. Limited to 3 per address and 10 per IP per hour.

Request Body

The account’s address

Media type application/json

object

email

string

Example

sam@example.eu

Responses

202

Accepted

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

status

string

Example

{
  "data": {
    "status": "accepted"
  }
}

400

The address is not an address

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

details

object

field

string

Allowed values: email code password

Example

{
  "details": {
    "field": "email"
  }
}

429

Too many requests for this address or from this IP; see Retry-After

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

Temporarily unavailable

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}