Link domains

Endpoints

The RecipientDomain object

idstringrequired

The link domain's ID, starting cdm_.
objectstringrequired

Always recipient_domain.
hostnamestringrequired

The hostname your delivery links use, such as afhending.fyrirtaeki.example: lower case, an internationalised name in its ASCII (xn--) form. At least three labels, so not a bare domain, and never under parasend.com.
statestringrequired

pending_dns: the ownership TXT or the CNAME is not seen yet. verifying: both are seen and the domain is being set up. issuing_cert: its certificate is being issued. active: links use it. degraded: it was active and a check now fails. failed: it could not be set up, or stayed degraded for 72 hours. removed: taken off your list.
One of pending_dns verifying issuing_cert active degraded failed removed
reasonstring · nullablerequired

Why it waits, is degraded or failed: ownership_not_found, cname_not_found, lookup_failed, tenants_off, certificate_pending, deploying, dns_not_pointing, claimed_elsewhere, hostname_in_use_elsewhere (the hostname is still on another CloudFront distribution: remove it there, then Check now), certificate_<status>, tenant_missing, tenant_disabled, degraded_72h, organization_erased.
recordsarray of objectrequired

The ownership TXT and the CNAME, expected and seen; a caa record only when CAA is published.
7 fields of records
- records[].recordstringrequired
  
  Which record this is: ownership, the TXT record that proves the hostname is yours; cname, the CNAME that points it at Parasend; caa, your CAA record, listed only when you publish one.
  One of ownership cname caa
- records[].typestringrequired
  
  The DNS record type: TXT for ownership, CNAME for cname, CAA for caa.
  One of TXT CNAME CAA
- records[].namestringrequired
  
  The DNS name to publish at (for caa, the name whose CAA governs the hostname).
- records[].valuestringrequired
  
  What it should hold.
- records[].seenarray of stringrequired
  
  What the last check found there.
- records[].okbooleanrequired
  
  Whether the last check found the record as it should be.
- records[].viastring
  
  Ownership proved by the parent domain, which your organisation alone has verified for e-mail.
  One of parent_domain
caa_hintbooleanrequired

CAA is published and names no Amazon issuer, so no certificate can be issued.
certificateobject · nullablerequired

The hostname's TLS certificate, by its status; null until one has been requested.
1 field of certificate
- certificate.statusstring
  
  pending-validation, issued, failed, validation-timed-out, revoked, expired or inactive.
used_byobjectrequired

How many brand profiles in use name this domain in their current version (brand_profiles).
1 field of used_by
- used_by.brand_profilesintegerrequired
  
  Profiles in use whose current version names it (a count).
  at least 0
verified_atstring · date-time · nullablerequired

When both DNS records were first seen together; the hostname is your organisation's from then on.
active_sincestring · date-time · nullablerequired

When the domain last became active, in ISO 8601 (UTC); null if it never has.
degraded_sincestring · date-time · nullablerequired

When the domain, while active, began failing its checks, in ISO 8601 (UTC); null when it is not degraded. After 72 hours degraded it becomes failed.
failed_atstring · date-time · nullablerequired

When the domain became failed, in ISO 8601 (UTC); null otherwise.
last_checked_atstring · date-time · nullablerequired

When its DNS was last checked, in ISO 8601 (UTC); null before the first check. Parasend checks every 15 minutes, and when you call POST /recipient_domains/{id}/check.
created_atstring · date-timerequired

When the domain was added, in ISO 8601 (UTC).
removed_atstring · date-time · nullablerequired

When the domain was removed with DELETE /recipient_domains/{id}, in ISO 8601 (UTC); null while it is on your list.