Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Domains

Replace current maindomain with different one

Updates the site's domain name

put/v1/sites/{id}/maindomain

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

domainstring

Site's new domain name

active_wordpress_domain'cdn_url' | 'live_domain'

Switch between the Live domain name and CDN URL. WARNING: WordPress can only have 1 URL and this will break your live site if you switch to CDN URL

remove_live_domainboolean

Use this in conjunction with active_wordpress_domain set to cdn_url to revert this site back to a cdn_url from live domain. Warning: This will cause the live domain to no longer function and will remove all additional domains

convert_addon_to_maindomainboolean

Use this to convert an addon domain to the maindomain. The domain passed will be converted from an addon domain to the maindomain and the existing maindomain will be removed.

Example request

{
  "domain": "newdomain.rocket.net"
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": []
}