domains

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

Where and how to change this domain's nameservers.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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 our…
`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

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