domains
POST /v1/domain-watches
Watch a domain — any domain, including one registered elsewhere.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織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 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