Dmarc

Enable DMARC monitoring

Turns monitoring on and returns the domain's report address and the DMARC record to publish: the current record with the address added to rua=, keeping the policy and any other report addresses. With apply, the record is also written through a DNS provider connected in the dashboard. Calling it again returns the same address.

post/domains/{id}/dmarc

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/domains/{id}/dmarc
  • Auth: HTTP bearer

Request body

apply'cloudflare' | 'vercel' | 'godaddy'

Write the DMARC record through this connected DNS provider

digest_enabledboolean

Weekly digest email on or off (default on)

Response

Monitoring is on

appliedobject nullable

The DNS provider and what changed, when apply was used

apply_errorstring

Why the DNS provider could not update the record (add it by hand)

Example response

{
  "dmarc": {
    "report_address": "k3m9q2xw7hb4npr6@dmarc.groundmail.dev",
    "rua": "mailto:k3m9q2xw7hb4npr6@dmarc.groundmail.dev",
    "dns": {
      "host": "_dmarc.example.com"
    },
    "readiness": {
      "label": "Safe to move to quarantine"
    }
  }
}

Changes

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