Sign in
Authentication

Request password reset

Changed on

Generates recovery token and stores it (email sending pending). Returns generic message to prevent email enumeration. Project is identified via the anon key.

post/auth/forgot-password

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/auth/forgot-password
  • Auth: HTTP bearer

Request body

emailstring email required

Response

Generic success message (doesn't reveal if email exists)

messagestring

Example response

{
  "message": "If the email exists, a password reset link has been sent"
}

Changes

  • 3a6f365f3f35Revision changes
    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

  • bb44e98aba2eRevision changes
    • ▲

      the response's body type changed from object to no type for status

    • ▲

      the response's body type changed from object to no type for status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status