domains
POST /v1/domain-watches
Watch a domain — any domain, including one registered elsewhere.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את 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 domai… |
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 w… |
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