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, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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 domain…
`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 we…
`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`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 422