Skip to content
The API may change between versions while TTX-Zone is 0.x.

Regenerate backup codes

POST
/api/v1/auth/totp/backup-codes/regenerate
curl --request POST \
--url https://example.com/api/v1/auth/totp/backup-codes/regenerate \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <X-CSRF-Token>' \
--cookie ttx_access_token=<ttx_access_token> \
--data '{ "password": "example" }'

Replace the backup codes, shown only in this answer.

Media typeapplication/json
TotpBackupCodesRegenerateRequest
object
password
Any of:
string
>= 1 characters <= 1024 characters

Example generated

{
"password": "example"
}

Successful Response

Media typeapplication/json
TotpBackupCodesRegenerateResponse
object
backup_codes
required
Backup Codes
Array<string>

Example generated

{
"backup_codes": [
"example"
]
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}