domains

POST /v1/domains/connect

Host DNS for a domain the customer already owns.

所有 domains 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 domains.dns.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

您的组织 ID 应填在此处

此端点接受 org_id 作为 JSON 正文中的一个字段。

您的组织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.

请求正文

名称类型必填内容简介
fqdnstringThe domain to host DNS for. Must be a zone apex, not a subdomain.
org_idUuidThe organization to connect it in. Optional when the caller holds `domains.dns.manage` in exactly one org; required otherwise.

响应

名称类型必填内容简介
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnHostnameA fully-qualified DNS hostname, lowercase, no trailing dot.
sldstring
tldstring
product_linestringThe 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_modestring<registered, connected, transferring_in>
statusDomainStatusA domain's lifecycle state (docs/31 §4.10).
registered_atobject
expires_atobject
auto_renewboolean
renew_yearsinteger
registrar_lockboolean
privacy_enabledboolean
nameserversstring[]
dnssec_enabledboolean
site_idUuid | nullThe site this domain points at, if any.
created_atstring
updated_atstring
delegationDelegationWhere 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