---
title: "Pre-flight a domain"
method: POST
path: "/api/v1/domains/check"
tags: ["Domains"]
---

# Pre-flight a domain

`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`)

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.

## Headers

- `DoDomain-Team` string

## Request body

- CheckDomainInput
  - `domain` string, required

## Response `200`

Success.

- CheckDomainResponse
  - `confidence` 'high' | 'medium' | 'low', required
  - `domain` string, required
  - `domainConnect` object, required
    - `discovered` boolean, required
    - `providerId` string
    - `providerName` string
  - `guide` object, required
    - `apexToken` '@' | '(blank)' | '%domain%', required
    - `dashboardUrl` string
    - `hostFormat` string, required
    - `label` string, required
    - `notes` string[]
    - `provider` string, required
    - `steps` string[], required
  - `label` string, required
  - `method` 'oauth' | 'domain-connect' | 'guided', required
  - `nameServers` string[], required
  - `oneClickAvailable` boolean, required
  - `provider` string, required
  - `tier` union, required
    - 1
    - 2
    - 3
  - `zone` string, required

## Other responses

- `400`: `400 invalid_request` — The request body or query failed schema validation, or a documented capability rule rejected it. `details` carries the field-level report when the failure came from schema validation.
- `401`: `401 unauthorized` — No `Authorization: Bearer` header, or the credential is malformed, unknown, or (for OAuth tokens) fails verification.
- `403`: `403 forbidden` — The OAuth access token was not granted the scope this operation requires. `details.code` is `SCOPE_MISSING` and `details.requiredScope` names the scope. Secret keys (`dd_sk_`) carry no scopes and never see this for a missing scope. The one-click start routes also answer it for a session created without one-click (a Free-plan team's session): no `details`, and the end user falls back to the manual records.
- `404`: `404 not_found` — The addressed resource does not exist, or the caller does not own it — the two collapse to one status on purpose, so an id cannot be enumerated by a caller who does not own it.
- `429`: `429 rate_limited` — Rate limited. `Retry-After` (seconds) is set and `details.retryAfterSeconds` repeats it. Branch on `details.reason`: `request_rate` means the caller is calling too fast (`details.limit` carries the cap), `recently_checked` means this one connection was DNS-checked inside its cooldown.
- `500`: `500 internal` — An unhandled server-side failure. Reported to our error tracker; safe to retry.

---

[API](https://skmtc.dev/dodomain/apis/dodomain-api.md) · [All operations](https://skmtc.dev/dodomain/apis/dodomain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dodomain/apis/dodomain-api/revisions/44cfb944de58?raw)