CustomDomain™ docs
API referenceConnections

What public DNS shows for each record, and what is left to do

GET
/connections/{id}/diagnose

Read-only, record-by-record check of a connection against live public DNS. For each record in the desired set it reports found, missing, mismatch (something else answers for the name; observed shows what, observed_label names a well-known service behind it) or unverifiable, plus the name to type in a DNS panel (@ for the root) and at_provider when the domain's own nameservers already serve the value and only public caches lag. issues lists problems that block the connection even when a record looks right: doubled_host (the full hostname typed into the Name field), cloudflare_proxied, aaaa_conflict, extra_a_records, conflicting_record and caa_blocks. It never changes the connection; when all_found is true, call :recheck to verify and go live. Cached for about 5 seconds.

A delegated agent token needs domains:read.

Authorization

AuthorizationBearer <token>

Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/connections/string/diagnose"
{  "connection_id": "string",  "domain": "string",  "zone": "string",  "provider": "string",  "status": "pending",  "checked_at": "2019-08-24T14:15:22Z",  "all_found": true,  "found_count": 0,  "total": 0,  "next_check_seconds": 0,  "records": [    {      "type": "string",      "host": "string",      "name": "string",      "value": "string",      "ttl": 0,      "priority": 0,      "status": "found",      "observed": [        "string"      ],      "observed_label": "string",      "at_provider": true    }  ],  "issues": [    {      "code": "doubled_host",      "severity": "blocking",      "name": "string",      "host": "string",      "observed": [        "string"      ],      "message": "string"    }  ]}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}