⚠️ Deprecation Notice

Warning: API V1 is deprecated and will no longer receive support, updates, or bug fixes.

We strongly recommend migrating to API V2 for:

  • Continued technical support
  • Access to new features and improvements
  • Security updates and bug fixes
  • Optimal performance and reliability

Please refer to the V2 API Documentation for migration guidance.

This is API documentation of Dmarc Report.

Auth

Dmarc Report supports basic HTTP token based authentication. To get API token, follow these instructions.

  1. Signup for Dmarc Report at app.dmarcreport.com.

  2. After logging in, click on your profile icon and select API Tokens from the dropdown.

  3. Click on New Api Token.

  4. Select privileges for this token and click save.

To authenticate, you need to set Authorization header with Token token=<token>.

So your Authorization header should look like:

Authorization: Token token=6fdd07dd6c3e36440cc8ae64282181ecf71f7d0437bf35b3f01f9f99eb518

Resources

Agg reports
List, Search and Paginate the Aggregate Reports. Plus get all the details of an individual Aggregat Report.

Resource Description
GET https://api.dmarcreport.com/v1/domains/:domain_id/agg_reports.json List, Search and Paginate Aggregte Reports
GET https://api.dmarcreport.com/v1/domains/:domain_id/agg_reports/records.json Get all the details of a Aggregte Reports records
GET https://api.dmarcreport.com/v1/domains/:domain_id/agg_reports/:id.json Get all the details of a Aggregte Report

Domain memberships
List of all domains in your team. Plus you can add, remove and veiw details of domains in your team.

Resource Description
GET https://api.dmarcreport.com/v1/teams/:team_id/domain_memberships.json List of all Domains in your Team
GET https://api.dmarcreport.com/v1/teams/:team_id/domain_memberships/:id.json Details of certain Domain in your team
POST https://api.dmarcreport.com/v1/teams/:team_id/domain_memberships.json Add your Domain in your Team
DELETE https://api.dmarcreport.com/v1/teams/:team_id/domain_memberships/:id.json Remove Domain from your team

Domains
List all the domains of the user. Plus get all the details of an individual Domain.

Resource Description
GET https://api.dmarcreport.com/v1/domains List of all Domains
GET https://api.dmarcreport.com/v1/domains/:id Get all the details of a Domain
POST https://api.dmarcreport.com/v1/domains.json Add your domain

Forensic reports
List, Search and Paginate the Failure Reports. Plus get all the details of an individual Aggregate Report.

Resource Description
GET https://api.dmarcreport.com/v1/domains/:domain_id/forensic_reports.json List, Search and Paginate Failure Reports
GET https://api.dmarcreport.com/v1/domains/:domain_id/forensic_reports/:id.json Get all the details of a Failure Report

Mta sts reports
List, Search and Paginate the MTA STS Reports. Plus get all the details of an individual Aggregat Report.

Resource Description
GET https://api.dmarcreport.com/v1/domains/:domain_id/mta_sts_reports.json List, Search and Paginate MTA Reports
GET https://api.dmarcreport.com/v1/domains/:domain_id/mta_sts_reports/mta_failure_details.json List, Search and Paginate MTA Reports
GET https://api.dmarcreport.com/v1/domains/:domain_id/mta_sts_reports/:id.json Get all the details of a MTA Report

Teams
List of your all teams. Plus you can create, update and delete.

Resource Description
GET https://api.dmarcreport.com/v1/teams.json List of all teams
POST https://api.dmarcreport.com/v1/teams.json Creates a new team
PUT https://api.dmarcreport.com/v1/teams/:id.json Updates your team
DELETE https://api.dmarcreport.com/v1/teams/:id.json Delete your team

User memberships
List of all user in certain team. Plus you can add, update and remove user from your team.

Resource Description
GET https://api.dmarcreport.com/v1/teams/:team_id/user_memberships.json List of all Users in certain team
GET https://api.dmarcreport.com/v1/teams/:team_id/user_memberships/:id.json Details of certain User Membership
POST https://api.dmarcreport.com/v1/teams/:team_id/user_memberships.json Add a user in your team
PUT https://api.dmarcreport.com/v1/teams/:team_id/user_memberships/:id.json Update certain user in your team
DELETE https://api.dmarcreport.com/v1/teams/:team_id/user_memberships/:id.json Remove user from your team