get/domains/{id}

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/domains/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Unique domain identifier

Response

OK

idstring required

Unique identifier of the domain

domainstring required

Fully qualified domain name

status'NOT_STARTED' | 'PENDING' | 'VERIFYING' | 'VERIFIED' | 'INVALID' | 'FAILED' required

Current verification status

verifiedboolean required

Whether the domain has been fully verified

verificationCooldownUntilstring date-time nullable required

Earliest time a re-verification can be attempted, or null if no cooldown

verificationTokenstring required

Token value to place in DNS records for verification

verificationMethod'DNS_TXT' | 'DNS_CNAME' required

DNS record method used for domain verification

dkimSelectorstring nullable required

DKIM selector used for email signing, or null if not configured

dkimPublicKeystring nullable required

DKIM public key for DNS publication, or null if not configured

spfConfiguredboolean required

Whether SPF DNS records are correctly configured

dmarcConfiguredboolean required

Whether DMARC DNS records are correctly configured

mxConfiguredboolean required

Whether MX DNS records are correctly configured

feedbackEnabledboolean required

Whether bounce and complaint feedback processing is enabled

createdAtstring date-time required

Timestamp when the domain was added

Changes

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