Check a connection's DNS now, and report what public DNS answered
recheck connection: reference page for this CustomDomain™ API operation in the connections group. Covers parameters, request body, responses and error codes.
Resolves every record the connection is verified against in-request, against live public DNS, and returns a per-record verdict. This is the verb behind a "check now" button, as opposed to GET /connections/{id}, which only reports what the background propagation poller last saw.
It also advances the connection: a pending or propagating connection whose records are all visible is promoted to live here rather than on the poller's next pass, and a failed connection is re-entered into verification (failed → pending) with its lifecycle timeout clock re-based off the retry. Without that re-basing the retry would re-fail immediately, since the connection is failed precisely because it aged past that window. A live connection is reported on but never transitioned: records_resolved: false on a live connection is a drift signal.
Idempotent and safe to call repeatedly.
A delegated agent token needs domains:connect, because a recheck can move a connection forward. Its answer carries no end_user_ref, the platform's id for its end user.
A widget token must be the connection's end user: a connection that names another end user than the token's end_user_ref, or names one while the token names none, answers 403 token_wrong_end_user and is not rechecked or revived, and a connection that names none is the token's as before. An API key, an app-scoped token and a delegated agent token are not limited by it.
Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/connections/string:recheck"{ "id": "string", "application_id": "string", "domain": "string", "host": "string", "provider_id": "string", "setup_type": "automatic", "status": "pending", "managed": true, "created_at": "2019-08-24T14:15:22Z", "sandbox": true, "last_checked_at": "2019-08-24T14:15:22Z", "www_redirect": true, "override_spf": true, "validate_dmarc": true, "validate_caa": true, "monitor": true, "batch_id": "string", "end_user_ref": "string", "client_label": "string", "retried_at": "2019-08-24T14:15:22Z", "routing": { "mode": "edge", "cname_target": "string", "apex_ipv4": [ "string" ], "set_at": "2019-08-24T14:15:22Z" }, "records_source": "integrator", "created_via": "", "secure_root_domain": true, "redirect_to": "http://example.com", "power_root_path_access": [ "string" ], "error_code": "string", "error_message": "string", "write_rail": "api_key", "provider_account_id": "string", "removal_started_at": "2019-08-24T14:15:22Z", "dns_hosting": { "state": "none", "by": "customdomain", "provider": "string", "zone": "string", "since": "2019-08-24T14:15:22Z" }, "records": [ { "type": "CNAME", "host": "string", "value": "string", "ttl": 3600, "priority": 0, "applied": true, "change": "created", "prior": [ { "type": "string", "value": "string", "ttl": 0, "priority": 0 } ], "prior_source": "provider" } ], "end_user_email": "[email protected]", "ask_end_user_email": true, "credential": { "account_id": "string", "provider": "string", "status": "active", "name": "string", "scopes": [ "string" ], "account": "string", "session_id": "string", "verified_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "notice": "d30", "reconnect_reason": "expiring", "reconnect_sent_at": "2019-08-24T14:15:22Z", "renewed_at": "2019-08-24T14:15:22Z", "old_key": "revoke_by_hand", "revoke_url": "http://example.com", "rights": [ "transfer" ] }, "reach": { "kind": "account", "account_id": "string", "label": "string", "provider": "string", "can_reapply": true, "managed_possible": true }, "checked": [ { "type": "CNAME", "host": "string", "value": "string", "ttl": 3600, "priority": 0, "applied": true, "change": "created", "prior": [ { "type": "string", "value": "string", "ttl": 0, "priority": 0 } ], "prior_source": "provider", "resolved": true } ], "records_resolved": true, "retried": true, "previous_status": "pending"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}