/v1/exposures/emailCompliance

get https://api.birddogsecurity.com/v1/exposures/emailCompliance

Retrieves a list of email compliance exposures for DKIM, DMARC, and SPF. The results can be filtered by compliance type and are paginated.

Responses

Response body

object

recordCount

integer

The total number of records available.

currentPage

integer

The current page number.

totalPages

integer

The total number of pages.

pageLimit

integer

The limit of records per page.

results

array of objects

results

object

customerId

string

The ID of the customer.

customerName

string

The name of the customer.

assetId

string

The asset ID associated with the exposure.

exposureId

string

The exposure ID.

domainName

string

The domain name associated with the exposure.

riskRank

number

The risk rank associated with the exposure.

exposureType

string

The type of the exposure (dkim, dmarc, or spf).

dkimCompliant

boolean

Indicates if DKIM is compliant.

dkimDomain

string

The domain for DKIM.

dkimRecordPublished

boolean

Indicates if the DKIM record was published.

dkimSelector

string

The DKIM selector used in the test.

dkimReason

string

Reason for DKIM non-compliance, if applicable.

dmarcCompliant

boolean

Indicates if DMARC is compliant.

dmarcRecordPublished

boolean

Indicates if the DMARC record was published.

dmarcPolicy

string

The DMARC policy value (e.g., reject, quarantine, none).

dmarcPolicyCheck

string

The result of the DMARC policy check.

dmarcReason

string

Reason for DMARC non-compliance, if applicable.

dmarcRecord

string

The DMARC record retrieved.

dmarcRuaPresent

boolean

Indicates if the RUA reporting email is present.

dmarcRufPresent

boolean

Indicates if the RUF forensic reporting email is present.

spfCompliant

boolean

Indicates if SPF is compliant.

spfDnsLookupCount

integer

The number of DNS lookups in the SPF record.

spfDnsLookupsWithinLimit

boolean

Indicates if the DNS lookup count is within the limit.

spfIpAddressesValid

boolean

Indicates if the IP addresses in the SPF record are valid.

spfReason

string

Reason for SPF non-compliance, if applicable.

spfRecord

string

The SPF record retrieved.

spfRecordPublished

boolean

Indicates if the SPF record was published.

spfSyntaxCorrect

boolean

Indicates if the SPF record syntax is correct.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.birddogsecurity.com/v1/exposures/emailCompliance \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A paginated list of email compliance exposures.

401Unauthorized: API key is missing or invalid.

500Database error occurred.