Connections

List connections

Newest-first list of connections and their live DNS health. A secret key lists its own app's connections; an OAuth token with connections:read lists team-wide and may narrow with appId. Disconnected connections are excluded unless includeDisconnected=true. Page past the 100-row ceiling by passing the previous page's nextCursor as cursor; the cursor is opaque — never construct one.

get/api/v1/connections

Request

  • Base URL: https://app.dodomain.io
  • URL: https://app.dodomain.io/api/v1/connections
  • 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)

Query parameters

appIdstring
domainstring
limitinteger
cursorstring
includeDisconnectedboolean

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.

nextCursorstring nullable required

Changes

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