Request a password-reset email
const url = 'https://api.aetherpush.com/v1/auth/forgot-password';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"email":"adrian@aetherpush.com"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.aetherpush.com/v1/auth/forgot-password \ --header 'Content-Type: application/json' \ --data '{ "email": "adrian@aetherpush.com" }'Initiates a password-reset flow. To prevent enumeration of registered emails, the response is the same generic message whether or not the email matches an account.
Rate limited to 3 requests per IP per 60 minutes. Further requests for the same account within 60 seconds, or after five in an hour, still receive this generic 200 response and do not mint a new link.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Example
{ "email": "adrian@aetherpush.com"}Responses
Section titled “Responses”Generic confirmation message.
Generic response with a single human-readable message field. Used by password-reset and resend-verification flows where the server returns a generic message regardless of whether the target account exists, to prevent enumeration attacks.
object
Example
{ "message": "If an account with that email exists, check that inbox for a password reset link."}Email missing.
Standard error envelope. code is the stable machine identifier for
client branching and i18n. The wording of error is a human-readable
fallback and is not part of the contract. Specialized responses keep
narrower code enums where clients already branch on them.
object
Human-readable error message.
Stable machine code. Prefer this over matching on error. The
values this API can answer with are listed in the ApiErrorCode
schema of the raw document at
https://api.aetherpush.com/openapi.yaml. The field stays an
open string here so that a release adding a value does not
invalidate this response.
Unique identifier for the request, also exposed as the X-Request-Id response header.
Example
{ "error": "Email is required.", "code": "email_required", "requestId": "req_abc123"}Too many password-reset requests.
Returned with HTTP 429 when an endpoint-specific rate limit is hit,
including the per-tenant management API budget. Not the process-wide
address limiter (see GlobalAddressRateLimitErrorResponse).
retryAfterSeconds
indicates how long the client should wait before retrying, and matches
the Retry-After header when that header is set. code names the
limit that fired so clients can translate without matching on error.
object
Example
{ "error": "Too many password reset requests. Please try again later.", "code": "too_many_password_reset_requests", "retryAfterSeconds": 3600, "requestId": "req_abc123"}Internal server error.
Standard error envelope. code is the stable machine identifier for
client branching and i18n. The wording of error is a human-readable
fallback and is not part of the contract. Specialized responses keep
narrower code enums where clients already branch on them.
object
Human-readable error message.
Stable machine code. Prefer this over matching on error. The
values this API can answer with are listed in the ApiErrorCode
schema of the raw document at
https://api.aetherpush.com/openapi.yaml. The field stays an
open string here so that a release adding a value does not
invalidate this response.
Unique identifier for the request, also exposed as the X-Request-Id response header.
Example
{ "error": "The requested resource was not found.", "code": "not_found", "requestId": "req_abc123"}