mailnix Docs
    mailnix / REST: providers

    API reference

    REST: providers

    The destination CRUD surface. A destination is one configured outbound provider (your webhoster's SMTP, SES, Postmark, Resend, Mailgun, or a custom SMTP host); routing rules and failover policies decide which destination each message uses.

    Endpoints

    • GET /v1/destinations: list yours.
    • POST /v1/destinations: create one. SMTP presets exist for common webhosters so you only supply mailbox credentials.
    • GET /v1/destinations/{id}/health: probe-backed health snapshot (reachability, auth, latency).
    • PATCH /v1/destinations/{id}/mode: flip between sandbox (sends are captured, nothing relays) and live.
    • POST /v1/destinations/{id}/promote-to-live: idempotent go-live shortcut.

    Related configuration endpoints:

    • POST /v1/routing/rules: create a routing rule (match on from address / domain, pick a destination, priority-ordered).
    • POST /v1/failover/policy: set a primary and fallback chain.
    • GET /v1/projects/me and PATCH /v1/projects/me/no-route-policy: what happens when no destination matches (capture, reject, or relay_default).

    Full request/response schemas live in the OpenAPI spec.

    Sandbox first

    New destinations start in sandbox mode: sends through them are captured into the project's test inbox instead of relaying. Promote to live once a test send looks right. The concepts are covered in Destinations, Routing rules, and Failover policies.