Domains

List domains for a website

Returns every domain record attached to the website, oldest first: the automatically allocated platform subdomain plus any custom domains. Platform subdomains are always active; custom domains carry their current verification status and the DNS records still expected.

get/websites/{websiteId}/domains

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/websites/{websiteId}/domains
  • Auth: HTTP bearer

Path parameters

websiteIdstring required

Response

All domain records for the website, oldest first.

idstring required

Unique domain id.

hostnamestring required

Fully-qualified lowercase hostname, e.g. blog.example.com.

status'pending_dns' | 'pending_verification' | 'active' | 'failed' | 'removing' | 'suspended' required

pending_dns: waiting for the required DNS records; pending_verification: DNS found, waiting for the edge host to become ready; active: serving traffic; failed: verification failed (see failureMessage); removing: being deregistered from the edge; suspended: disabled by Cactal trust & safety. Platform subdomains are always active.

kind'platform_subdomain' | 'custom' required

Every website automatically gets one platform_subdomain; custom domains are added through this API.

isPrimaryboolean required

Whether this is the canonical custom domain that published traffic redirects to. Always false for platform subdomains.

failureMessagestring nullable required

What the most recent verification check found wrong, including whether ownership is missing, the hostname is unreachable, or traffic reaches a service other than Cactal. null when nothing is wrong.

lastCheckedAtstring date-time nullable required

When DNS and edge status were last checked. null before the first check.

createdAtstring date-time required

When the domain record was created.

Changes

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