Hostingsurge Email API

The Email API from Hostingsurge — 27 operation(s) for email.

GitHub OpenAPI

Operations 36

GET /email/domains Email domains: ownership, mailbox and sending status, DNS to publish #
POST /email/domains Add a domain (a domain you own; not hostingsurge.com/.app). #
GET /email/domains/{domainId} One domain with its full DNS plan and live check #
DELETE /email/domains/{domainId} Remove a domain (best-effort mailcow cleanup) #
POST /email/domains/{domainId}/verify Re-check DNS: verifies ownership if not yet proven, and activates… #
POST /email/domains/{domainId}/mailboxes/enable Enable or disable mailboxes on mailcow for this domain #
POST /email/domains/{domainId}/sending/enable Enable or disable transactional sending on Postal for this domain (the… #
POST /email/domains/{domainId}/cloudflare/preview DNS at Cloudflare: what one click would write (MX, SPF, DKIM, DMARC) and what… #
POST /email/domains/{domainId}/cloudflare/apply DNS at Cloudflare: write the plan of the preview (its planHash). #
GET /email/domains/{domainId}/mailboxes Mailboxes of a domain, with mailcow quota usage #
POST /email/domains/{domainId}/mailboxes Create a mailbox. #
PATCH /email/mailboxes/{mailboxId} Change password, quota, name or active state #
DELETE /email/mailboxes/{mailboxId} Delete a mailbox (best-effort mailcow cleanup) #
GET /email/domains/{domainId}/aliases Aliases and the catch-all address of a domain #
POST /email/domains/{domainId}/aliases Create an alias or the domain catch-all #
PATCH /email/aliases/{aliasId} Change destinations or active state #
DELETE /email/aliases/{aliasId} Delete an alias #
GET /email/mailboxes/{mailboxId}/sync-jobs IMAP import jobs of a mailbox #
POST /email/mailboxes/{mailboxId}/sync-jobs Import an existing mailbox over IMAP (mailcow syncjob). #
DELETE /email/sync-jobs/{syncJobId} Cancel/remove an import job #
GET /email/sending Transactional sending status for your organization (on once a sending domain… #
GET /email/usage Transactional email quota and usage: recipients today (UTC), this billing… #
POST /email/sending/request Optional note for the operator: sending turns on by itself once a sending… #
POST /email/sending/operator Platform operator only: enable (optionally overriding the daily/monthly quota)… #
POST /email/sending/credential Create (rotate) an SMTP credential for postal.hostingsurge.com:587. #
GET /email/messages Recent transactional sends (this platform's own log; see docs/EMAIL.md) #
GET /email/messages/{messageId}/deliveries Live delivery attempts for one message, from Postal #
POST /emails Send a transactional email through Postal. #
GET /projects/{projectId}/site-email Email of the website's domains: state, DNS records, last 7 days for each #
POST /projects/{projectId}/site-email Set up email for one domain of this website: creates the sending domain and… #
PUT /projects/{projectId}/site-email/account Connect the team's own Resend account with a Full access key, or replace the… #
DELETE /projects/{projectId}/site-email/account Forget the team's Resend key. Domains that already send keep their own keys #
POST /projects/{projectId}/site-email/check Check the DNS records of every domain still waiting; once one verifies, the… #
POST /projects/{projectId}/site-email/{domain}/dns/cloudflare Add this domain's mail records at Cloudflare with an API token you paste. #
POST /projects/{projectId}/site-email/{domain}/resume Resume this domain after a pause #
DELETE /projects/{projectId}/site-email/{domain} Stop this domain's email: revokes the key, removes the domain and its two… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hostingsurge-com:hostingsurge-com-email-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hostingsurge-com-email-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Hostingsurge Platform Email API
  version: 1.0.0
  description: 'Deploy and operate projects on Hostingsurge: Git/upload/Docker/WordPress projects, deployments, logs, environment variables, domains and databases. Errors are {"error":{"code","message","details?"}}.'
servers:
- url: /api/v1
  description: Same origin as the dashboard, e.g. https://hostingsurge.com/api/v1
security:
- bearerAuth: []
- sessionCookie: []
tags:


# --- truncated at 32 KB (540 KB total) ---
# Full source: https://artifacts.apis.io/hostingsurge-com/openapi/hostingsurge-com-email-api-openapi.yml