domains

POST `/v1/domain-watches`

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

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Feld im JSON-Body.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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.

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`fqdn`	`string`	Ja	Any registrable domain, including one registered elsewhere.
`org_id`	`string`	Nein	The organisation to watch it for. Defaults to the caller's own.

Antwort

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

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 422