domains

POST `/v1/domain-watches`

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

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Où insérer l'ID de votre organisation

Cet endpoint prend org_id comme champ dans le corps JSON.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`fqdn`	`string`	Oui	Any registrable domain, including one registered elsewhere.
`org_id`	`string`	Non	The organisation to watch it for. Defaults to the caller's own.

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`string`	Oui	—
`fqdn`	`string`	Oui	Normalised lowercase punycode.
`source`	`string<registered, hosting, manual>`	Oui	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`	Non	The `Domain` row, when the watched name is one of ours.
`site_id`	`string`	Non	—
`muted`	`boolean`	Oui	Whether alerts are currently suppressed.
`muted_until`	`string`	Non	—
`expires_at`	`string`	Non	⛔ `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`	Non	Whole days, or `null` when `expires_at` is unknown.
`registrar`	`string`	Non	As the registry reports it. Empty when redacted or not yet read.
`nameservers`	`string[]`	Non	—
`status`	`string[]`	Non	The EPP status set — `clientHold`, `redemptionPeriod`, `pendingDelete`, …
`last_checked_at`	`string`	Non	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`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422