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