domains
GET /v1/domains/{domainId}/registrar-guide
Where and how to change this domain's nameservers.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/registrar-guide \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
*"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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
domainId (path) | Uuid | Ano | The domain's id. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
slug | string<godaddy, namecheap, porkbun, cloudflare, squarespace, generic> | Ano | 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 | Ano | 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 | Ano | A deep link into that registrar's own nameserver screen, where known. |
self_serve | boolean | Ano | 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 | Ano | 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[] | Ano | 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[] | Ano | Where the registry says the domain delegates right now. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 429 · 503