Get email domain security
curl --request GET \
--url https://app.msportal.ai/api/public/v1/documentation/email-domain-security \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.msportal.ai/api/public/v1/documentation/email-domain-security"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.msportal.ai/api/public/v1/documentation/email-domain-security', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.msportal.ai/api/public/v1/documentation/email-domain-security",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.msportal.ai/api/public/v1/documentation/email-domain-security"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.msportal.ai/api/public/v1/documentation/email-domain-security")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.msportal.ai/api/public/v1/documentation/email-domain-security")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"company_domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>",
"domain": "<string>",
"is_primary": true,
"overall": "pass",
"checks": {
"spf": "pass",
"dmarc": "pass",
"dkim": "pass",
"mta_sts": "pass",
"tls_rpt": "pass",
"dnssec": "pass",
"bimi": "pass"
},
"dmarc_policy": "<string>",
"dmarc_pct": 123,
"dmarc_enforced": true,
"spf_safe": true,
"mail_provider": "<string>",
"spf_record": "<string>",
"dmarc_record": "<string>",
"dkim_selectors_checked": [
"<string>"
],
"dkim_selectors_found": [
"<string>"
],
"findings": [
"<string>"
],
"checked_at": "<string>",
"last_error": "<string>"
}
],
"pagination": {
"page": 2,
"limit": 50,
"totalCount": 123,
"totalPages": 123,
"hasNextPage": true,
"hasPrevPage": true
},
"summary": {
"domains": 123,
"checked": 123,
"passing": 123,
"warning": 123,
"failing": 123,
"dmarcEnforced": 123,
"dmarcMonitoring": 123,
"dmarcMissing": 123,
"spfSafe": 123,
"spfMissing": 123,
"dkimFound": 123,
"mtaSts": 123,
"tlsRpt": 123,
"dnssec": 123,
"bimi": 123,
"lastCheckedAt": "<string>"
}
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}Documentation
Get email domain security
Email authentication posture of client domains from MSPortal’s daily public-DNS check: SPF, DMARC (policy, pct, enforced), DKIM, MTA-STS, TLS-RPT, DNSSEC and BIMI per domain, worst first, plus a summary. DKIM is only looked up at selectors the mail provider is known to use, so unknown DKIM is never a failure. Requires the domain_email_auth_checks feature and the linked user’s read_documentation_domains or read_security permission.
GET
/
api
/
public
/
v1
/
documentation
/
email-domain-security
Get email domain security
curl --request GET \
--url https://app.msportal.ai/api/public/v1/documentation/email-domain-security \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.msportal.ai/api/public/v1/documentation/email-domain-security"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.msportal.ai/api/public/v1/documentation/email-domain-security', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.msportal.ai/api/public/v1/documentation/email-domain-security",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.msportal.ai/api/public/v1/documentation/email-domain-security"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.msportal.ai/api/public/v1/documentation/email-domain-security")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.msportal.ai/api/public/v1/documentation/email-domain-security")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"company_domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>",
"domain": "<string>",
"is_primary": true,
"overall": "pass",
"checks": {
"spf": "pass",
"dmarc": "pass",
"dkim": "pass",
"mta_sts": "pass",
"tls_rpt": "pass",
"dnssec": "pass",
"bimi": "pass"
},
"dmarc_policy": "<string>",
"dmarc_pct": 123,
"dmarc_enforced": true,
"spf_safe": true,
"mail_provider": "<string>",
"spf_record": "<string>",
"dmarc_record": "<string>",
"dkim_selectors_checked": [
"<string>"
],
"dkim_selectors_found": [
"<string>"
],
"findings": [
"<string>"
],
"checked_at": "<string>",
"last_error": "<string>"
}
],
"pagination": {
"page": 2,
"limit": 50,
"totalCount": 123,
"totalPages": 123,
"hasNextPage": true,
"hasPrevPage": true
},
"summary": {
"domains": 123,
"checked": 123,
"passing": 123,
"warning": 123,
"failing": 123,
"dmarcEnforced": 123,
"dmarcMonitoring": 123,
"dmarcMissing": 123,
"spfSafe": 123,
"spfMissing": 123,
"dkimFound": 123,
"mtaSts": 123,
"tlsRpt": 123,
"dnssec": 123,
"bimi": 123,
"lastCheckedAt": "<string>"
}
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}Authorizations
Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.
Query Parameters
Required range:
1 <= x <= 100000Items per page
Required range:
1 <= x <= 100Restrict to one company
Only domains in this state
Available options:
pass, warn, fail, pending, dmarc_not_enforced Search domain or company name
Maximum string length:
200Was this page helpful?