domains

GET /v1/domains/{domainId}/registrar-guide

Where and how to change this domain's nameservers.

Minden domains végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) sites.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/registrar-guide \
  -H "Authorization: Bearer zdk_live_…"

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

*"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.

Paraméterek

NévTípusKötelezőMi ez
domainId (path)UuidIgenThe domain's id.

Válasz

NévTípusKötelezőMi ez
slugstring<godaddy, namecheap, porkbun, cloudflare, squarespace, generic>IgenWhich instruction set to render. ⛔ A slug, never step text — a client supplies its own localized steps. `generic` is a real answer covering every registrar.
registrarstringIgenThe 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_urlstringIgenA deep link into that registrar's own nameserver screen, where known.
self_servebooleanIgenCan we make the change for the customer with an API key they supply? Derived from which delegation adapters exist, never stated per registrar.
lockedbooleanIgenThe domain cannot be delegated anywhere else — true for Cloudflare Registrar. ⛔ A STATE, not a failure, and not the same as `self_serve: false`.
expectedstring[]IgenThe 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.
nameserversstring[]IgenWhere the registry says the domain delegates right now.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429 · 503