Site Check
Special endpoint that can be used to see if a URL is available for publishing

Site Check

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.
1
GET /api/v2/sites/check/?formatted_domain=example.com&base_directory=/
Copied!

Parameters

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 (/)

Response

If the URL is available
1
{
2
"available": true
3
}
Copied!
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
1
{
2
"available": false,
3
"object_class": "Site",
4
"object_pk": 1710945
5
}
Copied!
Last modified 1yr ago