domains
POST /v1/domain-watches
Watch a domain — any domain, including one registered elsewhere.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Waar je organisatie-id komt te staan
Dit eindpunt verwacht org_id als een veld in de JSON-body.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/domain-watches \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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.
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
fqdn | string | Ja | Any registrable domain, including one registered elsewhere. |
org_id | string | Nee | The organisation to watch it for. Defaults to the caller's own. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | string | Ja | — |
fqdn | string | Ja | Normalised lowercase punycode. |
source | string<registered, hosting, manual> | Ja | 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 domai… |
domain_id | string | Nee | The `Domain` row, when the watched name is one of ours. |
site_id | string | Nee | — |
muted | boolean | Ja | Whether alerts are currently suppressed. |
muted_until | string | Nee | — |
expires_at | string | Nee | ⛔ `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 w… |
days_until_expiry | integer | Nee | Whole days, or `null` when `expires_at` is unknown. |
registrar | string | Nee | As the registry reports it. Empty when redacted or not yet read. |
nameservers | string[] | Nee | — |
status | string[] | Nee | The EPP status set — `clientHold`, `redemptionPeriod`, `pendingDelete`, … |
last_checked_at | string | Nee | 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 | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 422