Check your domain’s progress (and move it forward)
verify_domainCheck how far a custom domain has got, and move it forward one step right away (no waiting for the background pass). Returns state, step / of, done, what it is waiting for (waiting), why it is stuck (reason), retry_after_s (when to check again; null = no need to poll), the records to add, what we see on public DNS when records are not live yet (seen), plus next, can_do (what you can do now) and say (one sentence to relay to the user as it is). Poll after retry_after_s until state=active; when next=user_action, tell the user can_do and check again once they are done; when next=contact_us, ask the user to contact us. Also call it when the user asks “is it ready” or “why does it not open”. Read-only workspace members can check too.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hostname | No | The domain itself, such as go.acme.com; pass this or domain_id | |
| domain_id | No | The domain_id returned by bind_domain / list_domains; pass this or hostname |