generateRecoveryCodes
POST
/api/v1/me/security/recovery-codes
const url = 'https://example.com/api/v1/me/security/recovery-codes';const options = { method: 'POST', headers: {'X-CSRF-Token': 'example', 'Content-Type': 'application/json'}, body: '{"password":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/me/security/recovery-codes \ --header 'Content-Type: application/json' \ --header 'X-CSRF-Token: example' \ --data '{ "password": "example" }'Replaces every unused code. Requires the account password. The plain codes are returned exactly once.
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters”X-CSRF-Token
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
password
required
The account password, reverified so a borrowed session cannot weaken sign-in security on its own.
string
Examplegenerated
{ "password": "example"}Responses
Section titled “ Responses ”Ten new recovery codes
Media typeapplication/json
object
data
required
object
codes
required
Array<string>
Examplegenerated
{ "data": { "codes": [ "example" ] }}The password was not correct