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 domain… |
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 we… |
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