Documentation

Guides for the DMARCguard API and a reference for every documented endpoint.

Guides

Getting started with the API
Create an API key, make your first request and learn the conventions every endpoint follows.
Authentication
How API keys are issued, scoped, bound to an organization and revoked, and what each 401 and 403 means.
Rate limits
The hourly quota, the abuse controls in front of it, the headers that report them and how to pace a client.
Single sign-on
Connect your identity provider with OpenID Connect, verify your email domain, and decide whether password login stays available.
Changelog
Dated changes to the API contract and the documentation.

Read your organization's DMARC data programmatically. Authenticate with an API key, page with limit and offset, and watch the rate-limit headers.

Overview
Base URL, versioning, authentication and the errors every request can return.
Reports
Aggregate (RUA) reports as received, parsed and classified.
Analytics
Organization-wide and per-domain rollups computed by DMARCguard.
Domains
The domains you monitor and their health.
Sources
Who sends mail as your domains, and whether they should.
Events
Conditions that needed attention and whether they were acknowledged.
API keys
How much of the hourly budget the organization's keys have used.
Vocabulary
The enumerations other responses use, keyed by category: verification states, severities, grades, policies and reputation.

Service status shows current incidents and scheduled maintenance.

Every API response carries an X-Request-Id header. Quote it when you write to support@dmarcguard.io about a specific request.