Domains

Create a domain

Adds a new domain to the organization. The response includes the reporting_email and dmarc_record strings — copy them into your DNS to start receiving DMARC reports.

Returns 400 if the request body is malformed or name is missing, 409 Conflict if the domain already exists in the organization, and 402 Payment Required if the organization has hit its plan domain limit.

post/api/v1/domains

Request

  • Base URL: https://api.dmarc-examiner.com
  • URL: https://api.dmarc-examiner.com/api/v1/domains
  • Auth: API key in header X-API-Key

Request body

namestring required

Domain name. Stored lowercased.

Example request

{
  "name": "example.com"
}

Response

Domain created

idstring uuid required
namestring required
status'verified' | 'pending' | 'failed' required
verified_atstring date-time nullable
last_report_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
reporting_emailstring email required

Address to set in the rua= tag of your DNS DMARC record so reports are delivered to this organization.

dmarc_hoststring required

DNS host where the DMARC record must be published.

dmarc_recordstring required

DMARC record string ready to copy into your DNS as a TXT record. Includes a ruf= tag only if the current plan supports forensic reports.

Example response

{
  "name": "example.com",
  "reporting_email": "org-abc123@reports.dmarc-examiner.com",
  "dmarc_host": "_dmarc.example.com",
  "dmarc_record": "v=DMARC1; p=none; rua=mailto:org-abc123@reports.dmarc-examiner.com"
}

Changes

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