domains

POST `/v1/domain-watches`

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

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

A szervezet azonosítójának helye

Ez a végpont a org_id mezőt várja a JSON törzsben.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`fqdn`	`string`	Igen	Any registrable domain, including one registered elsewhere.
`org_id`	`string`	Nem	The organisation to watch it for. Defaults to the caller's own.

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`string`	Igen	—
`fqdn`	`string`	Igen	Normalised lowercase punycode.
`source`	`string<registered, hosting, manual>`	Igen	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`	Nem	The `Domain` row, when the watched name is one of ours.
`site_id`	`string`	Nem	—
`muted`	`boolean`	Igen	Whether alerts are currently suppressed.
`muted_until`	`string`	Nem	—
`expires_at`	`string`	Nem	⛔ `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`	Nem	Whole days, or `null` when `expires_at` is unknown.
`registrar`	`string`	Nem	As the registry reports it. Empty when redacted or not yet read.
`nameservers`	`string[]`	Nem	—
`status`	`string[]`	Nem	The EPP status set — `clientHold`, `redemptionPeriod`, `pendingDelete`, …
`last_checked_at`	`string`	Nem	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`	Igen	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422