Docs

GET /domains/{id}/wait

Long-poll a domain until it is verified or failed, or until timeout (0–25 seconds). timeout=0 is a snapshot. Does not re-check DNS; the server checks on its own.

Parameters

  • id path · string · required
  • timeout query · integer · optional

Responses

  • 200 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
deadlinestring | nullyes
idstringyes
namestringyes
next_poll_secondsintegeryes
progressobjectyes
progress.required_totalintegeryes
progress.required_verifiedintegeryes
reason"ok" | "not_found" | "unreachable" | "mismatch" | "dkim_key_mismatch" | "domain_check_window_expired" | nullyes
status"pending" | "verified" | "failed" | "partially_verified" | "partially_failed"yes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.