Connections

Read one connection

Re-reads a single connection's live DNS health by the connectionId every connection.* webhook payload carries — without listing and filtering client-side, which is impossible past the paging ceiling anyway. The body is byte-identical to one element of GET /api/v1/connections's connections[], so one parser serves both. Unlike the list's default, a DISCONNECTED connection is still returned: a caller naming an id already knows the row exists, and disconnectedAt is exactly what it came to read. The OAuth scope is connections:read — this reads, it never mutates.

get/api/v1/connections/{connectionId}

Request

  • Base URL: https://app.dodomain.io
  • URL: https://app.dodomain.io/api/v1/connections/{connectionId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.dodomain.io/api/auth/oauth2/authorize, token URL https://app.dodomain.io/api/auth/oauth2/token, scopes: connections:read)

Path parameters

connectionIdstring required

The connection id from GET /api/v1/connections, or the connectionId on a connection.* webhook payload.

Headers

DoDomain-Teamstring

The id of the team this call acts on, from GET /api/v1/teams. Needed only when the credential can use more than one team (an OAuth connection granted several); a secret key has exactly one. A team the credential cannot use is refused 404 TEAM_NOT_FOUND — the same answer whether the team exists or not.

Response

Success.

appIdstring required
brokenAtstring date-time nullable required
createdAtstring date-time required
disconnectedAtstring date-time nullable required
domainstring required
fqdnstring required
idstring required
lastCheckedAtstring date-time nullable required
recordFqdnsstring[] required
sessionIdstring required
status'active' | 'broken' required
verifiedAtstring date-time nullable required

Changes

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