API

API Reference

All endpoints exposed by the Fastify server, with links to detailed pages.

Auth: x-api-key for /v2, JWT for /mail and /ws.

API Explorer

Click an endpoint below to preload a request template, then send it and inspect the response.

WebSocket auth headers cannot be set by browser WebSocket APIs. Use the cURL output for /ws.

Base URL

Auth

API key (x-api-key)
JWT (Authorization: Bearer)
Dovecot HMAC secret (optional)

Request

Query JSON
Headers JSON (optional)
Body (JSON or raw text)
Idle
{ "note": "Select an endpoint from the table to begin." }

Filter endpoints

Search by method, path, or description.

Method Path Auth Description Details
GET / public Serve the documentation home page. Introduction
GET /docs public Serve the documentation home page (alias). Introduction
GET /docs/* public Serve static documentation assets and pages. Introduction
POST /v2/domain api key Create a managed domain and seed DNS records. Domains
GET /v2/domains/:domain api key Fetch a domain including DNS and routing details. Domains
POST /v2/domains/delete api key Delete a domain and its related records. Domains
PUT /v2/domains/:domain/route api key Update domain routing mode and webhook settings. Domains
GET /v2/domains/:domain/dns api key Fetch DNS requirements and status. Domains
POST /v2/domains/:domain/dns/mark api key Manually mark a DNS record status. Domains
GET /v2/domains/:domain/email-accounts api key List email accounts for a domain. Accounts
POST /v2/email-accounts/create api key Create a mailbox for a managed domain. Accounts
GET /v2/email-accounts api key List email accounts (optional domain filter). Accounts
GET /v2/email-accounts/:id api key Fetch an email account by id. Accounts
PUT /v2/email-accounts/:id api key Update display name or status. Accounts
POST /v2/email-accounts/delete api key Delete an email account. Accounts
POST /v2/email-accounts/:id/password/reset api key Reset account password (returned once). Accounts
POST /mail/sync jwt Incremental IMAP sync for a mailbox. Mail
GET /mail/message jwt Fetch a full message with RFC822 source. Mail
GET /mail/attachment jwt Stream a specific MIME part as binary. Mail
WS /ws jwt Websocket connection for mailbox change events. Mail
POST /hooks/dovecot hmac Webhook for Dovecot push events. Webhooks
GET /metrics public Prometheus metrics scrape endpoint. Metrics