認証
ベアラー トークンとして API キーを送信します。キーには domains.dns.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/domains/connect \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Creates the domain's zone at our DNS provider, branded with our vanity nameservers in the same operation, and returns the delegation to set at the customer's **own** registrar. This is the BYO path — we become the authoritative DNS, **not** the registrar — so it needs no registrar credential and is how "premium DNS included on every plan" is delivered. The domain must be a zone apex (a subdomain is a `422`) and must not already exist on the platform (a `409` — worded so it never confirms another tenant holds it). Requires `domains.dns.manage`, the same authority that governs the records this makes editable. ⛔ There is deliberately **no `product_line` field**: it is derived server-side from the org's subscriptions, because it decides whether shared fleet A/AAAA records are hidden from this customer. Accepting it would let a Footprint-Free customer connect a domain as `mainstream` and read the fleet IPs.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
fqdn | string | はい | The domain to host DNS for. Must be a zone apex, not a subdomain. |
org_id | Uuid | いいえ | The organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | Hostname | はい | A fully-qualified DNS hostname, lowercase, no trailing dot. |
sld | string | はい | — |
tld | string | はい | — |
product_line | string | いいえ | The product line this domain was created on. **Not decoration** — it is what decides whether the shared fleet A/AAAA records are hidden from the customer (register #93), so the… |
ownership_mode | string<registered, connected, transferring_in> | はい | — |
status | DomainStatus | はい | A domain's lifecycle state (docs/31 §4.10). |
registered_at | object | いいえ | — |
expires_at | object | いいえ | — |
auto_renew | boolean | はい | — |
renew_years | integer | はい | — |
registrar_lock | boolean | いいえ | — |
privacy_enabled | boolean | いいえ | — |
nameservers | string[] | はい | — |
dnssec_enabled | boolean | いいえ | — |
site_id | Uuid | null | いいえ | The site this domain points at, if any. |
created_at | string | はい | — |
updated_at | string | いいえ | — |
delegation | Delegation | はい | Where a domain's DNS delegation actually points. Several observations, not one boolean, because they answer different questions and collapsing them hides the only one that means… |
このエンドポイントが返すエラー
401 · 403 · 409 · 422 · 429 · 503