domains

Re-check custom domain

Force an immediate DNS re-check of a custom domain, instead of waiting for the automatic background check. The domain verifies on its own within a couple of minutes of you publishing the records, so this is only needed to speed that up. An account-wide key may re-check any domain; a pod-scoped key may re-check only a domain scoped to its own pod, never an account-wide domain. Inbox-scoped keys cannot manage domains.

post/v1/domains/{id}/verify

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/domains/{id}/verify
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Re-checked; the returned domain reflects the latest status

idstring

OpenMail domain ID

domainstring

The domain or subdomain, e.g. example.com or agent-mail.example.com.

podIdstring nullable

Pod this domain is scoped to, so only inboxes in that pod can use it, or null for an account-wide domain.

status'pending' | 'verifying' | 'verified' | 'failed' | 'under_review'

pending — added, records not yet published. verifying — being checked. verified — sending and receiving enabled. failed — records missing or wrong; publishing them and calling verify again is the fix. under_review — flagged as suspicious; DNS setup is blocked until approved.

verifiedAtstring date-time nullable
createdAtstring date-time
updatedAtstring date-time

Changes

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