domains
POST /v1/domain-watches
Watch a domain — any domain, including one registered elsewhere.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
L'ID della tua organizzazione va qui
Questo endpoint accetta org_id come campo nel corpo JSON.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/domain-watches \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
fqdn | string | Sì | Any registrable domain, including one registered elsewhere. |
org_id | string | No | The organisation to watch it for. Defaults to the caller's own. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | string | Sì | — |
fqdn | string | Sì | Normalised lowercase punycode. |
source | string<registered, hosting, manual> | Sì | 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 | No | The `Domain` row, when the watched name is one of ours. |
site_id | string | No | — |
muted | boolean | Sì | 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 w… |
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 | Sì | — |
Errori che questo endpoint può restituire
401 · 403 · 422