domains

GET /v1/domains/{domainId}/delegation

Whether a domain's delegation actually points at us.

すべての domains エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/delegation \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

The honest answer to "is my domain live yet?". expected is the delegation we ask the customer to set, nameservers is where the domain actually delegates right now, and detected says whether those agree. ⛔ detected is resolved from a public recursive resolver, not from the DNS vendor. Bunny's own NameserversDetected flag was measured returning true for a domain that is not registered at all, so a surface keyed off it tells a customer their domain is served before they have touched their registrar (docs/72 D243). A lookup that FAILED is a 503, never detected: false: "not live yet" and "we could not check" lead a customer to opposite actions. A domain whose authoritative DNS we do not host is a 404. Requires sites.view, RLS-scoped. The answer is recorded, not recomputed per request, so this read is cheap enough to poll — a background backoff poller keeps it fresh (see POST). A live lookup that fails on a domain last seen delegated leaves the recorded state alone, so the 503 now means we have never established this domain's delegation rather than this one lookup failed.

パラメータ

名前タイプ必須これがその内容です
domainId (path)UuidはいThe domain's id.

返信

名前タイプ必須これがその内容です
expectedstring[]はいThe delegation we ask the customer to set at their registrar. Resolved per domain, from the zone's own nameservers where the provider assigns them — Cloudflare issues each…
nameserversstring[]はいWhere the domain delegates right now, as the public internet sees it — which is what the customer compares against expected to know what to change.
detectedbooleanはいWhether the domain's public NS records include the nameservers we asked for, resolved from a public recursive resolver. This — not our configuration and not the DNS vendor's…
livebooleanはいWhether the domain is being served by us right now.
statestring<delegated, not_delegated, external, unknown>はいThe four-valued answer, and the field a client should render from. delegated — every nameserver we asked for is present. not_delegated — we hold this domain's zone, we got a…
answered_bystring<resolver, registry, none>はいWho answered. resolver is a public recursive resolver — what the internet sees. registry is the registry's own RDAP record, used as a fallback when the resolver says nothing…
checked_atstringはいWhen this reading was taken.
last_delegated_atstringはいWhen we last saw this domain delegated to us. Null means it never has been — which is what separates "waiting for you" from "this stopped working".
next_check_atstringはいWhen the background poller will look again, so a client can wait rather than poll blind. Null once the domain is live or the poller has given up.
driftedbooleanはいThis domain was delegated to us and positively is not any more. A warning about something that broke, not a step still to do.
served_by_usobjectいいえWhether a one-time token placed in the site's files on our servers came back when fetched through the domain's PUBLIC name — the only reading that can say the domain reaches us…
served_checked_atobjectいいえWhen served_by_us was last measured, or null for never.
www_resolvesobjectいいえWhether www. in front of the domain has any public address. null means the lookup did not answer, never that the name is missing.
dns_actionsobject[]いいえRecords the customer must add at THEIR DNS provider, exactly as written — only for a domain whose DNS we do not run (in a zone delegated to us, the platform publishes the record…
mail_measuredbooleanいいえWhether the domain's published mail (MX, SPF) has been read yet. While false, a mail_mismatch of null means NOT CHECKED, not "matches" — a client shows that beside any…
mail_mismatchnull | objectいいえPresent when the mail our copy of this domain's DNS would serve differs from the mail the domain publishes today — so changing nameservers to expected would change where its…

このエンドポイントが返すエラー

401 · 403 · 404 · 429 · 503