v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Domains

Set a domain for a Site

This can only be done on sites that are not staging sites. Once this is done, you must use PUT to change the maindomain

post/v1/sites/{id}/maindomain

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

domainstring

Site's domain name

keep_cdn_urlboolean

When set, DNS records for the live domain will be returned but the WordPress install will stay on the CDN URL (WordPress can only have one domain). This is useful for testing the site before going live while setting TXT records for SSL and Hostname validation

Example request

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

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

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