Domains

Verify a custom domain

Re-checks the ownership TXT record, edge readiness, and whether an HTTPS request to the hostname reaches this Cactal domain, then returns the updated status. A customer CDN or reverse proxy in front is supported when it forwards the verification request to Cactal. failureMessage distinguishes a missing ownership record, an unreachable hostname, and a hostname served somewhere else. Cactal asks the domain nameservers directly, so new records usually count on the next check, and this endpoint is safe to poll; Cactal also re-checks pending domains automatically (every minute for the first 2 hours, every 5 minutes for the first day, then every 15 minutes). The first custom domain to become active is promoted to primary automatically.

post/websites/{websiteId}/domains/{domainId}/verify

Request

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

Path parameters

websiteIdstring required
domainIdstring required

Response

The domain with its freshly checked status. When not yet active, failureMessage explains whether ownership, reachability, routing, or edge readiness needs attention.

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.