MENU navbar-image

Introduction

Use our API for 3-party system integration

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Endpoints

Get Domain Data.

requires authentication

Example request:
curl --request GET \
    --get "https://dmarc.centerasecurity.com/api/dmarc/aggre" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"dateRangeFrom\": \"2023-01-01\",
    \"dateRangeTo\": \"2023-01-31\"
}"
const url = new URL(
    "https://dmarc.centerasecurity.com/api/dmarc/aggre"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "dateRangeFrom": "2023-01-01",
    "dateRangeTo": "2023-01-31"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


[
    {
        "id": 44,
        "name": "centerasecurity.com",
        "total_volume": "15380",
        "total_threats": "122",
        "total_passed": "15258",
        "dkim_count": "15088",
        "spf_count": "13947"
    }
]
 

Request   

GET api/dmarc/aggre

Headers

Authorization        

Example: Bearer {YOUR_AUTH_KEY}

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

dateRangeFrom   string  optional    

The From date range for the overview.(default: 7 days ago) Example: 2023-01-01

dateRangeTo   string  optional    

The To date range for the overview.(default: now) Example: 2023-01-31