domains
POST /v1/domain-watches
Watch a domain — any domain, including one registered elsewhere.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Където отива идентификаторът на вашата организация
Този краен пункт приема org_id като поле в JSON тялото.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/domain-watches \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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.
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
fqdn | string | Да | Any registrable domain, including one registered elsewhere. |
org_id | string | Не | The organisation to watch it for. Defaults to the caller's own. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | string | Да | — |
fqdn | string | Да | Normalised lowercase punycode. |
source | string<registered, hosting, manual> | Да | 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 | Не | The `Domain` row, when the watched name is one of ours. |
site_id | string | Не | — |
muted | boolean | Да | Whether alerts are currently suppressed. |
muted_until | string | Не | — |
expires_at | string | Не | ⛔ `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 | Не | Whole days, or `null` when `expires_at` is unknown. |
registrar | string | Не | As the registry reports it. Empty when redacted or not yet read. |
nameservers | string[] | Не | — |
status | string[] | Не | The EPP status set — `clientHold`, `redemptionPeriod`, `pendingDelete`, … |
last_checked_at | string | Не | 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 | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 422