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.
Authorizations
Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.
Path Parameters
1Body
1Response
The platform subdomain at its new hostname, plus previousHostname: the address that was just released.
Unique domain id.
Fully-qualified lowercase hostname, e.g. blog.example.com.
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.
pending_dns, pending_verification, active, failed, removing, suspended Every website automatically gets one platform_subdomain; custom domains are added through this API.
platform_subdomain, custom Whether this is the canonical custom domain that published traffic redirects to. Always false for platform subdomains.
DNS records the domain owner must create for verification to succeed. Empty for platform subdomains.
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.
When DNS and edge status were last checked. null before the first check.
When the domain record was created.
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.