Domains

Get domain DNS records

Return the DNS records Shipmail requires for this domain and run a live, read-only DNS check. A connected domain needs four records: mx, spf, dkim and dmarc. A domain bought through Shipmail also returns mail_from_mx and mail_from_spf, which Shipmail publishes itself. This endpoint does not update the domain's persisted verification state.

get/domains/{id}/dns-records

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/domains/{id}/dns-records
  • 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

Required DNS records with live diagnostics.

object'dns_record_set' required
domain_idstring required
domain_namestring required
all_verifiedboolean required
checked_atstring date-time required

Changes

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