domains
GET /v1/domains/{domainId}/registrar-guide
Where and how to change this domain's nameservers.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/registrar-guide \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
*"Where do I actually go to change my nameservers?"* — the question a customer asks after being handed two hostnames. This answers it **without asking them which registrar they use**: the public registry already publishes the sponsoring registrar and its IANA id, so the answer is read from the same RDAP record the WHOIS card renders. `slug` is the instruction set to render — `godaddy`, `namecheap`, `porkbun`, `cloudflare`, `squarespace` or `generic`. ⛔ It is a **slug and never step text**: a client renders its own localized steps from it, because English instructions returned from an API cannot be translated for 58 locales. ⭐ `generic` is a real answer, not a failure. There are roughly 2,500 accredited registrars and "set these two nameservers wherever you bought the domain" is correct at every one of them. `self_serve` says whether we can make the change **for** the customer with an API key they supply, and it is derived from which delegation adapters exist rather than stated per registrar. `locked` says the domain **cannot** be delegated elsewhere at all — true for Cloudflare Registrar, which requires its own nameservers. Those two are different states and need different copy: `self_serve: false` means "you will have to do this by hand", `locked: true` means "there is nothing to do and no setting to look for". `expected` is the pair to set, resolved from the **zone's own** nameservers first rather than a fleet-wide constant — a footprint-free domain gets a provider-assigned pair. `nameservers` is where the registry says the domain points right now, so a client can say "already done" instead of repeating an instruction. Requires `sites.view`, RLS-scoped. A registry that does not answer is a `503`, never a generic card: both mean "we do not know your registrar" and only one of them says so.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
domainId (path) | Uuid | 是 | The domain's id. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
slug | string<godaddy, namecheap, porkbun, cloudflare, squarespace, generic> | 是 | Which instruction set to render. ⛔ A slug, never step text — a client supplies its own localized steps. `generic` is a real answer covering every registrar. |
registrar | string | 是 | The registrar exactly as the registry names it, or `null` when none was published. ⛔ Never inferred from `slug`: showing a brand name the registry did not state would present ou… |
panel_url | string | 是 | A deep link into that registrar's own nameserver screen, where known. |
self_serve | boolean | 是 | Can we make the change for the customer with an API key they supply? Derived from which delegation adapters exist, never stated per registrar. |
locked | boolean | 是 | The domain cannot be delegated anywhere else — true for Cloudflare Registrar. ⛔ A STATE, not a failure, and not the same as `self_serve: false`. |
expected | string[] | 是 | The nameservers this domain should be set to. Resolved from the zone's own nameservers first, so a provider-assigned pair is reported rather than a fleet-wide constant. |
nameservers | string[] | 是 | Where the registry says the domain delegates right now. |
此端点可能返回的错误
401 · 403 · 404 · 429 · 503