domains

PUT `/v1/domains/{domainId}/settings`

Change a domain's registrar settings.

احراز هویت

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

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

امتحان کنید

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

curl -X PUT https://api.zinndigital.com/v1/domains/{domainId}/settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

جزئیات

A **partial** update: an omitted field is left alone, never reset. Each changed flag is applied at the **registrar first** and mirrored onto our record only once it succeeds — so this endpoint never reports a protection (a transfer lock, WHOIS privacy) that the registrar has not actually applied. `auto_renew` is ours alone: we drive renewals, so it takes no registrar call. A registrar that refuses the change is a `503`. Requires `domains.dns.manage`.

پارامترها

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

بدنه درخواست

نام	نوع	الزامی	چیست
`auto_renew`	`boolean`	خیر	—
`transfer_lock`	`boolean`	خیر	—
`dnssec_enabled`	`boolean`	خیر	—
`privacy_enabled`	`boolean`	خیر	—

پاسخ

نام	نوع	الزامی	چیست
`registrar`	`string`	بله	The registrar driver holding this domain (a driver name, never a vendor id).
`auto_renew`	`boolean`	بله	Whether we renew it before expiry. Ours, not the registrar's.
`transfer_lock`	`boolean`	بله	Registrar transfer lock (`clientTransferProhibited`) — blocks an outbound transfer.
`dnssec_enabled`	`boolean`	بله	—
`privacy_enabled`	`boolean`	بله	WHOIS privacy / registrant redaction, where the TLD supports it.

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

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/domains/{domainId}/settings