POST /auth/reset-password-request
Send a password reset link to the user’s email. The user clicks the link and then submits a new password via POST /auth/reset-password.
Endpoint
Section titled “Endpoint”POST /v1/public/projects/:projectSlug/auth/reset-password-requestRequest Parameters
Section titled “Request Parameters”Path Parameters
Section titled “Path Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
projectSlug | string | ✅ | Your project’s unique slug |
Request Body
Section titled “Request Body”| Field | Type | Required | Description |
|---|---|---|---|
email | string | ✅ | User’s email address |
turnstileToken | string | ❌ | Turnstile token for captcha (if project uses it) |
Example Request Body
Section titled “Example Request Body”{ "email": "user@example.com"}Response
Section titled “Response”Success (200 OK)
Section titled “Success (200 OK)”{ "message": "If an account exists with this email, you will receive a password reset link shortly."}If the email is registered, a reset link is sent. The response is the same whether the email exists or not (to prevent email enumeration).
Error Responses
Section titled “Error Responses”| Status Code | Error Code | Description |
|---|---|---|
| 400 | INVALID_REQUEST | Invalid email |
| 429 | RATE_LIMIT_EXCEEDED | Too many requests |
| 500 | INTERNAL_SERVER_ERROR | Server error |
Available Hooks
Section titled “Available Hooks”- Event:
auth.password.reset.requested- When: After reset email is sent (or would be sent for existing user)
- Can do: Security logging, audit trails, user notifications
Configure in Project → Hooks. Learn more about hooks →
Try It Now
Section titled “Try It Now”POST
https://api.aerostack.dev/v1/public/projects/your-project/auth/reset-password-requestRelated Endpoints
Section titled “Related Endpoints”- POST /auth/reset-password - Set new password with token from email
- POST /auth/login - Login after reset