Site Check
Special endpoint that can be used to see if a URL is available for publishing
The Site Check endpoint is a way for you to make sure that a URL is available to publishing prior to creating or updating a Site or Proxy. It searches for any existing non-deleted or non-disabled Site or Proxy on our side.
GET /api/v2/sites/check/?formatted_domain=example.com&base_directory=/
Name | Type | Description |
formatted_domain | string | The hostname/domain, including the domain and subdomain (i.e www.example.com) |
base_directory | string | For landing pages, the directory that the page will be published. For websites published under a root domain is slash ( /) |
If the URL is available
{
"available": true
}
If the URL is not available, it will return details about the conflicting object
Field | Description |
object_class | Type of object ( Site, Proxy, DomainAlias) |
object_pk | ID of the object |
{
"available": false,
"object_class": "Site",
"object_pk": 1710945
}
Last modified 3yr ago