Connections

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

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.

get/connections/{id}/diagnose

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections/{id}/diagnose
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.customdomain.ai/oauth/agent/authorize, token URL https://api.customdomain.ai/oauth/agent/token, scopes: domains:read)

Path parameters

idstring required

Response

Diagnosis

connection_idstring required
domainstring required
zonestring required

The DNS zone a panel manages (the registrable domain).

providerstring
status'pending' | 'propagating' | 'live' | 'failed' required
checked_atstring date-time
all_foundboolean required
found_countinteger
totalinteger
next_check_secondsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.