Detect where a domain's DNS lives and how it will be set up
Read-only feature detection. Returns the provider, the chosen setup_type, whether automatic setup is possible, whether the OAuth-into-provider and one-click setup rails are available, capability flags (ns_support, wildcard_support, cname_flattening, spf_override_support, caa_support), social-login support, and any record_conflicts observed in public DNS. Unknown providers degrade to setup_type: manual.
Apex pre-flight: apex_supported reports whether the provider can host a CNAME-like record at the zone root, and apex_message is returned when this particular target needs one the provider cannot host — so an apex connection that would be refused at apply time is refused here instead, before any connection is created.
Authorization
widgetJWT Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/domains:check" \ -H "Content-Type: application/json" \ -d '{ "domain": "string" }'{ "domain": "string", "subdomain": "string", "registrable_domain": "string", "public_suffix": "string", "provider": "string", "setup_type": "automatic", "supports_automatic": true, "oauth_available": true, "domain_connect": true, "registered": true, "detection_error": "nxdomain", "authoritative_dns_provider": "string", "ns_support": { "root": true, "subdomains": true }, "wildcard_support": true, "cname_flattening": true, "apex_supported": true, "apex_message": "string", "spf_override_support": true, "caa_support": true, "supports_social_login": "string", "rails": { "oauth": { "available": true, "reason": "unknown_provider", "caveat": "string" }, "domain_connect": { "available": true, "reason": "unknown_provider", "caveat": "string" }, "api_key": { "available": true, "reason": "unknown_provider", "caveat": "string" }, "manual": { "available": true, "reason": "unknown_provider", "caveat": "string" } }, "recommended_rail": "oauth", "end_user_automatic": true, "blocked_reason": "unregistered", "dashboard_url": "string", "nameservers": [ "string" ], "integration_warnings": [ { "code": "supplied_apex_unrealizable", "message": "string" } ], "record_conflicts": [ { "kind": "string", "host": "string", "type": "string", "existing": "string", "desired": "string" } ], "conflict_tolerance": 0, "will_fallback_to_manual": true}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}