Domains

Get domain health

Return a domain's health in one read. dns and blocklist are the stored results of the check Shipmail runs every 6 hours: whether the MX, SPF, DKIM and DMARC records pass, and whether the Spamhaus Domain Block List (DBL) lists the domain. This endpoint does not run a new DNS check; use GET /domains/{id}/dns-records for a live one. delivery covers the recipients of messages sent from the domain's mailboxes that the API key can see, in the last 30 days, in total and split by recipient provider.

get/domains/{id}/health

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/domains/{id}/health
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

The domain's stored DNS and blocklist state and its last 30 days of delivery.

object'domain_health' required
domain_idstring required
domainstring required

Domain name.

generated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.