domains
POST /v1/domain-watches
Watch a domain — any domain, including one registered elsewhere.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
您的组织 ID 应填在此处
此端点接受 org_id 作为 JSON 正文中的一个字段。
您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/domain-watches \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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