alias.mom
On this page
Authentication What you can do Sign in with alias Self-hosting

The API

Everything the dashboard does, over HTTP.

Authentication

An API key in the Authentication header. Note the spelling: Authentication, not Authorization, and no Bearer prefix.

curl https://api.alias.mom/aliases \
  -H "Authentication: your-api-key"

Create keys in settings. They are shown once and stored hashed. Each key carries a scope, so a key for a script that only lists aliases cannot delete one.

What you can do

  • List, create, update, enable, disable and delete aliases
  • Manage mailboxes and contacts
  • Read per-alias activity
  • Manage custom domains

Rate limits apply per key. A 429 means slow down rather than stop.

Sign in with alias

Separate from the REST API: we are also an OpenID Connect provider, so your own application can offer "sign in with alias". Each user who signs in gets a dedicated alias for your app and a pairwise subject id, so two applications cannot correlate the same person between them.

The discovery document is at /.well-known/openid-configuration.

Self-hosting

The API is part of the open-source release, so a self-hosted instance exposes the same endpoints at your own domain. Point your client at your own base URL and nothing else changes.

Something here wrong or missing? Tell us. These pages live in the same repository as the code, so a correction is a one-line change.