domains

POST /v1/domains/{domainId}/auth-code

Reveal a domain's EPP transfer code.

همه نقاط پایانی domains

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز domains.dns.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/auth-code \
  -H "Authorization: Bearer zdk_live_…"

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Returns the domain's EPP/auth code, which **authorizes transferring the domain to another registrar**. It is fetched from the registrar on demand, returned once, and never stored or logged by us; the response is `no-store`. A `POST` deliberately, despite reading: revealing a credential must not be something a page load, a prefetch, a browser-history entry or a cache can trigger. The reveal is audit-logged (the code itself never is). Requires `domains.dns.manage`. **422 where the registrar publishes no auth-code endpoint at all** (the Cloudflare route). The refusal names the way out rather than simply declining — a customer is entitled to leave, so support fetches the code rather than the transfer being delayed.

پارامترها

نامنوعالزامیچیست
domainId (path)UuidبلهThe domain's id.

پاسخ

نامنوعالزامیچیست
auth_codestringبلهThe EPP/auth code. **A credential** — it authorizes moving the domain to another registrar. Do not store, log or display it beyond the confirmation that requested it.
expires_atstringبلهHow long to treat the displayed code as current. A presentation bound, not a promise of invalidation — most registrars do not publish a real lifetime.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 422 · 429 · 503