Domains

Get a domain

One domain: its verification state and the full DNS record set.

This is the endpoint to poll while a new domain propagates. On Amazon SES the status flips to verified once SES accepts the DKIM records; SES re-checks every five minutes for up to 72 hours and then marks the domain failed, so a domain stuck in pending past that window needs its records re-published, not more waiting.

get/v1/domains/{id}

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/domains/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Domain id.

Response

The domain with its DNS records.

domainIdstring required
projectIdstring
domainstring required
status'pending' | 'verified' | 'failed' required
dkimStatus'pending' | 'verified' | 'failed' | 'not_applicable'
spfStatus'pending' | 'verified' | 'failed'
dmarcStatus'pending' | 'verified' | 'failed'
trackingStatus'pending' | 'verified' | 'failed'
mailFromStatus'pending' | 'verified' | 'failed' | 'not_applicable'

Custom MAIL FROM subdomain (bounce.<domain>) — carries the bounce path and lets DMARC align SPF.

mailFromDomainstring nullable
selectorstring nullable

DKIM selector published at <selector>._domainkey.<domain>.

verifiedForSendingboolean

Whether the provider will currently accept mail from this domain.

dkimTokensstring[]

Legacy SES Easy DKIM CNAME tokens. Empty for domains onboarded with BYODKIM, which publish a single TXT record instead.

verificationTokenstring nullable
lastCheckedAtstring date-time nullable
createdAtstring date-time required

Changes

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