domains

POST `/v1/domain-watches`

Watch a domain — any domain, including one registered elsewhere.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Kung saan mapupunta ang id ng iyong organisasyon

Ang endpoint na ito ay kumukuha ng org_id bilang isang field sa JSON body.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

curl -X POST https://api.zinndigital.com/v1/domain-watches \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "fqdn": <string> }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`fqdn`	`string`	Oo	Any registrable domain, including one registered elsewhere.
`org_id`	`string`	Hindi	The organisation to watch it for. Defaults to the caller's own.

Tugon

Pangalan	Uri	Kailangan	Ano ito
`id`	`string`	Oo	—
`fqdn`	`string`	Oo	Normalised lowercase punycode.
`source`	`string<registered, hosting, manual>`	Oo	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`	Hindi	The `Domain` row, when the watched name is one of ours.
`site_id`	`string`	Hindi	—
`muted`	`boolean`	Oo	Whether alerts are currently suppressed.
`muted_until`	`string`	Hindi	—
`expires_at`	`string`	Hindi	⛔ `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`	Hindi	Whole days, or `null` when `expires_at` is unknown.
`registrar`	`string`	Hindi	As the registry reports it. Empty when redacted or not yet read.
`nameservers`	`string[]`	Hindi	—
`status`	`string[]`	Hindi	The EPP status set — `clientHold`, `redemptionPeriod`, `pendingDelete`, …
`last_checked_at`	`string`	Hindi	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`	Oo	—

Mga error na maibabalik ng endpoint na ito

401 · 403 · 422