domains
GET /v1/domains/{domainId}/registrar-guide
Where and how to change this domain's nameservers.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền sites.view; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/registrar-guide \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
"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.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
domainId (path) | Uuid | Có | The domain's id. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
slug | string<godaddy, namecheap, porkbun, cloudflare, squarespace, generic> | Có | 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 | Có | 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 our… |
panel_url | string | Có | A deep link into that registrar's own nameserver screen, where known. |
self_serve | boolean | Có | 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 | Có | 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[] | Có | 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[] | Có | Where the registry says the domain delegates right now. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 429 · 503