DevHub API Documentation
  • Introduction
  • Authentication
  • Errors
  • Getting started guides
    • Business-focused Sites
    • Location-focused Sites
    • Location pages and store locator with custom theme
    • Site publishing with site builder access
  • Code examples
    • Python
    • PHP
    • Perl
  • Best practices
    • Our unique IDs, versus yours
    • State and country codes
  • Core Resources
    • Sites
    • Businesses
    • Locations
    • Domains
    • Proxies
  • Content Resources
    • Pages
    • Content
    • Images
    • Files
    • Modules
    • Plugins
    • Themes
  • Logging and analytics
    • Analytics
    • Contact Logs
  • Single Sign On (SSO)
    • Introduction
    • Assigning a site's user
  • Live Preview API
    • What is the Live Preview API?
  • Advanced
    • Domain aliases
    • Language codes
    • Projects
    • Site Check
    • Traces
    • Webmail
  • Local Storage API
    • What is the Local Storage API?
  • Headless CMS
    • Locations search
  • Visitor Localization SDK
    • Visitor Localization SDK
Powered by GitBook
On this page
  • Site Check
  • Parameters
  • Response

Was this helpful?

  1. Advanced

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.

GET /api/v2/sites/check/?formatted_domain=example.com&base_directory=/

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

{
  "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
}
PreviousProjectsNextTraces

Last updated 4 years ago

Was this helpful?