| Code | Description |
|---|---|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server crashed for some reason |
{
"domains": [
{
"id": 2593,
"user_id": 1,
"address": "123.com",
"rua_report": true,
"ruf_report": true,
"mta_sts_report": null,
"dmarc_status": "dmarc_record_published",
"mta_sts_status": "mta_sts_inactive",
"created_at": "2023-03-31T11:49:04.099Z",
"updated_at": "2023-04-06T16:00:41.258Z"
},
{
"id": 2503,
"user_id": 1,
"address": "sampledomain.com",
"rua_report": true,
"ruf_report": true,
"mta_sts_report": false,
"dmarc_status": "dmarc_inactive",
"mta_sts_status": "mta_sts_inactive",
"created_at": "2022-04-15T11:05:05.212Z",
"updated_at": "2023-04-06T16:00:26.839Z"
},
{
"id": 2596,
"user_id": 1,
"address": "dmarcreport.com",
"rua_report": true,
"ruf_report": true,
"mta_sts_report": true,
"dmarc_status": "dmarc_record_published",
"mta_sts_status": "mta_sts_active",
"created_at": "2022-04-15T11:05:05.212Z",
"updated_at": "2023-04-06T16:00:26.839Z"
}
],
"shared_domains": [
{
"id": 2570,
"user_id": 1,
"address": "mnp.com",
"rua_report": true,
"ruf_report": true,
"mta_sts_report": false,
"dmarc_status": "dmarc_record_published",
"mta_sts_status": "mta_sts_inactive",
"created_at": "2023-02-16T07:19:01.255Z",
"updated_at": "2023-04-06T16:00:39.033Z"
},
{
"id": 2599,
"user_id": 1,
"address": "api-1.com",
"rua_report": true,
"ruf_report": true,
"mta_sts_report": null,
"dmarc_status": "dmarc_record_published",
"mta_sts_status": "mta_sts_inactive",
"created_at": "2023-04-03T15:31:57.028Z",
"updated_at": "2023-04-06T16:00:41.765Z"
}
]
}
The :id parameter can be either the numeric ID or the slug of the domain
| Code | Description |
|---|---|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server crashed for some reason |
{
"id": 16,
"user_id": 1,
"address": "abc.com",
"slug": "abc-com",
"rua_report": true,
"ruf_report": true,
"mta_sts_report": true,
"dmarc_status": "dmarc_active",
"mta_sts_status": "mta_sts_active",
"created_at": "2020-04-21T23:33:47.526Z",
"updated_at": "2023-04-06T16:00:24.086Z"
}
| Param name | Description |
|---|---|
|
id required |
Domain ID (numeric, e.g., “123”) or slug (e.g., “example-com”) Validations:
|
| Code | Description |
|---|---|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server crashed for some reason |
| Param name | Description |
|---|---|
|
domain required |
Validations:
|
|
domain[address] required |
Address of your domain Validations:
|
|
domain[rua_report] required |
Receives RUA Report against your domain Validations:
|
|
domain[ruf_report] required |
Receives RUF Report against your domain Validations:
|
|
domain[mta_sts_report] optional |
Receives MTA-STS Report against your domain Validations:
|
|
domain[tag_ids] optional |
Array of tag IDs to attach to the domain Validations:
|
|
domain[tag_names] optional |
Array of tag names to attach to the domain (must exist) Validations:
|
|
domain[mta_sts_policy] optional |
Validations:
|
|
domain[mta_sts_policy][mode] required |
Policy Mode Validations:
|
|
domain[mta_sts_policy][mx] required |
Detected Mail Records Separated by comma eg: custmx.cscdns.net, mail.dmarc.com Validations:
|
|
domain[mta_sts_policy][mx_age] required |
Policy Age (Valid Time in_days) Validations:
|