Email Auth
Email AuthDMARC Reports
Get DMARC Report Status
GET/zones/{zone_id}/email/auth/dmarc-reports
Configure DMARC Reports
PATCH/zones/{zone_id}/email/auth/dmarc-reports
ModelsExpand Collapse
DMARCReportGetResponse object { approved_sources, created, created_at, 9 more } Response for GET/PATCH /dmarc-reports
DMARCReportGetResponse object { approved_sources, created, created_at, 9 more }
Response for GET/PATCH /dmarc-reports
approved_sources: optional array of object { created, created_at, domain, 6 more } List of approved sending sources (omitted when empty)
approved_sources: optional array of object { created, created_at, domain, 6 more }
List of approved sending sources (omitted when empty)
records: optional object { bimi_records, cname_dkim_records, cname_dmarc_records, 4 more } Live DNS records for the zone, grouped by type
records: optional object { bimi_records, cname_dkim_records, cname_dmarc_records, 4 more }
Live DNS records for the zone, grouped by type
cname_dmarc_records: optional array of object { id, content, name, 2 more } CNAME records at _dmarc (problematic)
cname_dmarc_records: optional array of object { id, content, name, 2 more }
CNAME records at _dmarc (problematic)
DMARCReportEditResponse object { approved_sources, created, created_at, 9 more } Response for GET/PATCH /dmarc-reports
DMARCReportEditResponse object { approved_sources, created, created_at, 9 more }
Response for GET/PATCH /dmarc-reports
approved_sources: optional array of object { created, created_at, domain, 6 more } List of approved sending sources (omitted when empty)
approved_sources: optional array of object { created, created_at, domain, 6 more }
List of approved sending sources (omitted when empty)
records: optional object { bimi_records, cname_dkim_records, cname_dmarc_records, 4 more } Live DNS records for the zone, grouped by type
records: optional object { bimi_records, cname_dkim_records, cname_dmarc_records, 4 more }
Live DNS records for the zone, grouped by type
cname_dmarc_records: optional array of object { id, content, name, 2 more } CNAME records at _dmarc (problematic)
cname_dmarc_records: optional array of object { id, content, name, 2 more }
CNAME records at _dmarc (problematic)
Email AuthSPF
Email AuthSPFInspect
Inspect SPF Record
GET/zones/{zone_id}/email/auth/spf/inspect
ModelsExpand Collapse
InspectGetResponse object { components, domain, record, 2 more } Recursive SPF inspection tree
InspectGetResponse object { components, domain, record, 2 more }
Recursive SPF inspection tree
errors: optional array of object { code, domain, message, details } All errors encountered during inspection, collected from the entire tree.
This includes errors from nested includes at any depth, providing a quick
overview of all issues without needing to traverse the nested structure.
Each error includes a domain field to identify where it occurred.
Empty array if no errors (omitted from JSON when empty).
errors: optional array of object { code, domain, message, details }
All errors encountered during inspection, collected from the entire tree.
This includes errors from nested includes at any depth, providing a quick
overview of all issues without needing to traverse the nested structure.
Each error includes a domain field to identify where it occurred.
Empty array if no errors (omitted from JSON when empty).
code: string
Error code. Known values:
lookup_failed— DNS TXT lookup failedspf_not_found— no SPF record foundinvalid_spf— record does not start withv=spf1invalid_domain— PSL validation failedloop_detected— include/redirect cycle detectedinvalid_mechanism— unrecognised or malformed mechanismresource_limit_exceeded— internal resource protection limits exceeded (recursion depth or query budget)max_lookups— RFC 7208 10-lookup limit exceeded