Account recovery¶

Initiate account recovery

• HTTP Method: POST
• URL: https://example.domain.tld/api/v1/auth/password/recovery/
• Require authentication: No

Request parameters¶

Parameter	Type	Description	Required
username	str	Your account username	Required

Response parameters¶

Parameter	Type	Description
username	str	Your account username
message	str	Recovery message

Example request (Python)¶

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/auth/password/recovery/"
data = {
"username" : "admin"
}
r = requests.post(url, json=data)
try:
    pprint(r.json())
except: 
    print(r.text)

Example response (JSON)¶

{'message': 'Password recovery initiated if username exists. You will receive '
            'an email with recovery code shortly',
 'username': 'admin'}