---
title: "Request help."
method: POST
path: "/tf-rescue"
---

# Request help.

`POST /tf-rescue`

## Request body

- object
  - `help_setup` 'help' | 'email' | 'recovery_code' — What rescue option is desired.

## Response `200`

If 'email' was specified and SECURITY_TWO_FACTOR_RESCUE_EMAIL is True, then an authentication code was sent to the email on record for the user. If 'help' then an email was sent to administrator address specified by SECURITY_TWO_FACTOR_RESCUE_MAIL. If 'recovery_code' was specified and SECURITY_MULTI_FACTOR_RECOVERY_CODES is True, and the user had previously setup and downloaded a set of recovery codes the user will be redirected to SECURITY_MULTI_FACTOR_RECOVERY_URL.

- DefaultJsonResponseNoUser
  - `meta` object, required
    - `code` integer, required — Http status code
  - `response` object, required
    - `csrf_token` string — Session CSRF token

## Other responses

- `400` — Failed to send code

## Changes

- **2023-10-22** `b647a0e917e6` — 1 breaking, 3 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `400`
  - removed `#/components/schemas/BaseJsonResponse, subschema #2` from the response body `allOf` list for the response status `400`
  - added the required property `meta` to the response with the `400` status
  - added the required property `response` to the response with the `400` status
- **2022-07-22** `4b3ea48a957a` — 1 breaking, 2 warning, 2 info
  - the `allOf[subschema #2]/response/errors` response's property type/format changed from `object`/`` to `array`/`` for status `400`
  - removed the optional property `allOf[subschema #2]/response/error` from the response with the `400` status
  - removed the optional property `allOf[subschema #2]/response/errors/field-name` from the response with the `400` status
  - added the optional property `allOf[subschema #2]/response/field_errors` to the response with the `400` status
  - …1 more
- **2022-06-18** `2f80547852cc` — 1 breaking, 1 warning, 4 info
  - request property `help_setup` was restricted to a list of enum values (media type: application/x-www-form-urlencoded)
  - removed the request property `help-setup` (media type: application/json)
  - added the new optional request property `help_setup` (media type: application/json)
  - added the new `email` enum value to the request property `help_setup` (media type: application/x-www-form-urlencoded)
  - …2 more
- …earlier changes not shown

[Full history](https://skmtc.dev/pallets-eco/apis/flask-security-external-api/changes/tf-rescue/post.md)

---

[API](https://skmtc.dev/pallets-eco/apis/flask-security-external-api.md) · [All operations](https://skmtc.dev/pallets-eco/apis/flask-security-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pallets-eco/flask-security-external-api/revisions/ee92f388dafa/schema)