CustomDomain Docs
ReferenceAPI referenceDomains

Check one-click setup support for a domain (public)

Check one-click setup support for a domain (public): CustomDomain™ API reference. Covers request parameters, the request body, responses and error codes.

GET
/public/domain-connect-check

Unauthenticated helper behind the free Domain Connect support checker tool. Answers whether a domain's DNS provider supports one-click setup: it runs the same detection cascade as the widget (Domain Connect discovery probed ahead of NS-pattern matching) and cross-references the provider census. Results are cached for 24 hours per domain and the endpoint is rate-limited per IP; do not build product flows on it. Use the authenticated domains:check, which carries records-aware conflict and apex verdicts.

Query Parameters

domain*string

Hostname to check, e.g. example.com

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/public/domain-connect-check?domain=string"
{  "domain": "string",  "setup_type": "automatic",  "provider_id": "string",  "provider_name": "string",  "rail": "oauth",  "one_click": true,  "domain_connect": {    "supported": true,    "sync": true,    "async": true,    "provider": "string"  },  "also_provider": {    "provider": "string",    "provider_name": "string",    "reason": "former_google_domains"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}
{  "code": "account_not_verifiable",  "title": "string",  "details": "string",  "challenge": {    "value": "string",    "bits": 1,    "expires_at": "2019-08-24T14:15:22Z"  }}