Domains

Rename the platform subdomain

Moves the website to <label>.<platform domain>, the free address every website is allocated at creation. label is just the leading part: 1-40 characters, lowercase letters, digits, and inner hyphens, and it may not be one of the labels Cactal reserves. The change takes effect immediately, on published and draft hosts alike. The previous hostname is released at the same moment, with no redirect and no grace period, so any existing links to it break and another website may claim it. Take care on a published site. Fails with 409 when the label is already taken by another website; renaming to the label the website already has is a no-op. Custom domains are unaffected, and if one of them is primary it stays the canonical address.

post/websites/{websiteId}/domains/platform/rename

Request

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

Path parameters

websiteIdstring required

Request body

labelstring required

Response

The platform subdomain at its new hostname, plus previousHostname: the address that was just released.

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.

previousHostnamestring required

The hostname the website was reachable at before the rename. It is released immediately, so links to it stop working and another website may claim it.

Changes

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