Domains

Pre-flight a domain

Stateless pre-flight: which provider hosts the domain, which zone owns its records, which connect tier and flow it will get, whether one-click is actually available there (oneClickAvailable — tier: 2 alone only means the provider speaks Domain Connect, and many such providers serve none of DoDomain's templates), and the manual guide if it comes to that — without creating a session. Nothing is persisted. Available on every plan.

post/api/v1/domains/check

Request

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

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.

Request body

domainstring required

Response

Success.

confidence'high' | 'medium' | 'low' required
domainstring required
labelstring required
method'oauth' | 'domain-connect' | 'guided' required
nameServersstring[] required
oneClickAvailableboolean required
providerstring required
zonestring required

Changes

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