domains

PUT /v1/domains/{domainId}/settings

Change a domain's registrar settings.

所有 domains 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 domains.dns.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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)UuidThe domain's id.

请求正文

名称类型必填内容简介
auto_renewboolean
transfer_lockboolean
dnssec_enabledboolean
privacy_enabledboolean

响应

名称类型必填内容简介
registrarstringThe registrar driver holding this domain (a driver name, never a vendor id).
auto_renewbooleanWhether we renew it before expiry. Ours, not the registrar's.
transfer_lockbooleanRegistrar transfer lock (`clientTransferProhibited`) — blocks an outbound transfer.
dnssec_enabledboolean
privacy_enabledbooleanWHOIS privacy / registrant redaction, where the TLD supports it.

此端点可能返回的错误

401 · 403 · 404 · 422 · 429 · 503