Skip to content

Inspect a domain's current mail configuration before adding it

GET
/v1/domains/preflight

Read-only. Reports what is ALREADY configured on a domain so the user can see that something else is set up for the domain they are bringing in. Creates no SES identity and no domain record. blocking means the domain already receives mail (existing MX) and pointing it at Emithook would redirect that mail to us — POST /v1/domains will refuse it unless acknowledge_mx_conflict is set.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters

Query Parameters

domain*
Type
string
Required
Example"acme.com"

Responses

The domain's current mail configuration, graded.

application/json
JSON
{
  
"domain": "acme.com",
  
"severity": "string",
  
"current": {
  
  
"mx": [
  
  
  
"aspmx.l.google.com"
  
  
],
  
  
"spf": "v=spf1 include:_spf.google.com ~all",
  
  
"dmarc": "v=DMARC1; p=reject"
  
},
  
"reason": "acme.com already receives mail via aspmx.l.google.com"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Emithook · a Finnoto product