domains
POST /v1/domain-watches
Watch a domain — any domain, including one registered elsewhere.
Authentication
Send an API key as a bearer token. The endpoint checks domains.watch.manage; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/domain-watches \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Adds fqdn to the caller's watchlist with source: manual. ⭐ Idempotent by (org, fqdn): watching a domain that is already watched returns the existing row rather than erroring, because the customer's intent — "I want this watched" — is already satisfied and a 409 would be a worse answer to it. ⭐ Re-adding a domain the customer previously removed un-removes it. That is the one thing that clears removed_at, and it must be a deliberate act by the customer rather than a side effect of a provision.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
fqdn | string | Yes | Any registrable domain, including one registered elsewhere. |
org_id | string | No | The organisation to watch it for. Defaults to the caller's own. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
fqdn | string | Yes | Normalised lowercase punycode. |
source | string<registered, hosting, manual> | Yes | How it came to be watched. registered — we hold it. hosting — it is attached to a hosting account with us, whoever registered it. manual — the customer added it. ⛔ A domain… |
domain_id | string | No | The Domain row, when the watched name is one of ours. |
site_id | string | No | — |
muted | boolean | Yes | Whether alerts are currently suppressed. |
muted_until | string | No | — |
expires_at | string | No | ⛔ null is "the registry did not say", never "it does not expire". Render it as unknown; a client that treats it as a far-future date shows a customer a reassuring answer we… |
days_until_expiry | integer | No | Whole days, or null when expires_at is unknown. |
registrar | string | No | As the registry reports it. Empty when redacted or not yet read. |
nameservers | string[] | No | — |
status | string[] | No | The EPP status set — clientHold, redemptionPeriod, pendingDelete, … |
last_checked_at | string | No | When the registry last answered. ⛔ Every value on this row is a snapshot of the outside world taken at this instant, so it is never rendered without this beside it (§2.36). |
created_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 422