Domains

Add a domain

Register a new sending domain. Returns the DNS records that must be configured before the domain can be verified.

post/v1/domains

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/domains
  • Auth: HTTP bearer

Request body

domainstring required

The domain name to register for sending

Example request

{
  "domain": "yourapp.com"
}

Response

Domain created with DNS records to configure

idstring required
domainstring required
status'pending' | 'verifying' | 'verified' | 'failed' required

GET /v1/domains/{id} answers pending for a verified domain whose required records are no longer live.

verification_phase'verified' | 'dns_missing' | 'waiting_on_ses' | 'mail_from_pending' | 'failed'
verification_messagestring
next_auto_check_atstring date-time nullable

Null once the domain is verified

dkim_statusstring
spf_statusstring
dmarc_statusstring
mail_from_statusstring
mail_from_domainstring nullable
verified_atstring date-time nullable
regionstring
created_atstring date-time required
last_checked_atstring date-time nullable

Example response

{
  "id": "dom_xyz789",
  "domain": "yourapp.com",
  "status": "pending",
  "receiving": {
    "mx_record": {
      "type": "MX",
      "priority": 10
    }
  },
  "dkim_status": "verified",
  "spf_status": "verified",
  "dmarc_status": "pending",
  "mail_from_status": "verified",
  "mail_from_domain": "bounce.yourapp.com",
  "region": "us-east-1",
  "provider": {
    "id": "cloudflare",
    "name": "Cloudflare"
  },
  "events": [
    {
      "key": "dns_live",
      "label": "DNS records live"
    }
  ],
  "dns_records": [
    {
      "type": "CNAME",
      "name": "abc123._domainkey.yourapp.com",
      "value": "abc123.dkim.amazonses.com",
      "ttl": "Auto",
      "status": "pending",
      "purpose": "DKIM authentication"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.