---
title: "Start a password reset"
method: POST
path: "/forgot_password"
tags: ["Authentication"]
---

# Start a password reset

`POST /forgot_password`

## Request

- Base URL: `https://api.indexone.io`
- URL: `https://api.indexone.io/forgot_password`
- Auth: API key in header `x-api-key`

Emails a password-reset confirmation code. Complete the reset with `POST /forgot_password/confirm`.

## Request body

- object
  - `username` string, email, required

## Response `200`

Reset code sent. The body is the raw Cognito `ForgotPassword` response, which describes the delivery medium.

- object

## Other responses

- `400`: Unknown user, or Cognito rate-limited the reset. The Cognito exception is uncaught, so the body is a generic gateway error.
- `403`: Missing or invalid `x-api-key`.
- `429`: API key usage-plan rate limit exceeded.

---

[API](https://skmtc.dev/indexone/apis/index-one-rest-api.md) · [All operations](https://skmtc.dev/indexone/apis/index-one-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/indexone/apis/index-one-rest-api/revisions/df5a92216a9c?raw)