Email

Check email DNS status

Check email DNS verification status for a domain. Returns whether the domain is verified and ready, DNS record details, and mailbox count.

get/api/domains/{domain}/email/status

Request

  • Base URL: https://domani.run
  • URL: https://domani.run/api/domains/{domain}/email/status
  • Auth: HTTP bearer

Path parameters

domainstring required

Domain name

Response

Email status

domainstring
enabledboolean
verifiedboolean

True only when both receiving and outbound sending are verified

receiving_verifiedboolean

True when the domain's MX points at the platform's receiver, so mail for its addresses is accepted.

sending_configuredboolean
sending_verifiedboolean
mailbox_countinteger
dns_managedboolean

True when Domani writes the domain's zone itself: pending records are published and repaired by an hourly audit, nothing to add by hand. False for an external zone, where pending records must be added at the DNS provider.

unreachable_addressesstring[]

Addresses on the domain that its receiving MX refuses (api mailboxes on a hosted domain not yet registered on the mail host). Empty when every address can receive; registration is retried automatically.

provider_statusstring
mailbox_plan_keystring

The workspace's plan key that governs custom-domain mailboxes here (the workspace's own subscription, not necessarily the signed-in user's personal plan).

mailbox_limitinteger nullable

Custom-domain mailboxes the plan allows across the workspace. null is unlimited.

mailbox_limit_reachedboolean

True once the workspace is at its plan's mailbox limit: another mailbox on this domain needs an upgrade first.

hintstring

Example response

{
  "records": [
    {
      "name": "@",
      "value": "76.76.21.21",
      "ttl": 3600
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.