domains

PUT /v1/domains/{domainId}/dns/records/{recordId}

Update a DNS record.

所有 domains 端点

身份验证

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

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

免费试用

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

curl -X PUT https://api.zinndigital.com/v1/domains/{domainId}/dns/records/{recordId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "type": <DnsRecordType>, "value": <string> }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

Replaces the record `recordId` in the domain's hosted zone. Requires `domains.dns.manage`. A record hidden from the caller's product line (an A/AAAA on the Footprint-Free line) is indistinguishable from an absent one — a 404 — so it cannot be probed by id (register #93). **Repointing a live apex `MX` is refused** `409 MAIL_CHANGE_REFUSED` unless `confirm_mail_change=true` (issue #622) — it silently stops the customer's email reaching the mailboxes it reaches today, which is data loss rather than a configuration change. So is moving the only apex `MX` onto a subdomain: the record survives, the domain's mail does not. A change that alters only TTL or preference is not refused, because mail still arrives at the same host.

参数

名称类型必填内容简介
domainId (path)UuidThe domain's id.
recordId (path)stringThe DNS record's provider id.
confirm_mail_change (query)booleanSet `true` to proceed with a record change that would move or remove this domain's inbound email (issue #622). Without it, a write that stops mail reaching a host it reaches tod…

请求正文

名称类型必填内容简介
namestringThe record name — `@`/empty for the apex, or a relative/absolute host.
typeDnsRecordTypeA DNS resource-record type the shared editor supports (docs/31 §5.2).
valuestring
ttlinteger
priorityobject
proxiedobjectServe this record through the provider's HTTP proxy — Cloudflare's orange cloud. **`A` and `AAAA` only**; sending it on any other type is a `422` rather than a silent drop, beca…

响应

名称类型必填内容简介
idstringThe provider-assigned record id.
namestringThe record name — `@` for the apex, or a relative/absolute host.
typeDnsRecordTypeA DNS resource-record type the shared editor supports (docs/31 §5.2).
valuestringThe record value (target/content).
ttlintegerTime-to-live in seconds.
priorityobjectPriority for MX/SRV records; null otherwise.
proxiedobjectWhether this record is served through the provider's HTTP proxy — Cloudflare's **orange cloud**. Applies to `A` and `AAAA`; providers without a proxy ignore it. ⛔⛔ **Three state…
ownerDnsRecordOwnerWho may change this record. `platform` means the platform created it and converges it — the A/AAAA record at the apex or `www` that points the domain at the hosting we run for i…
driftDnsRecordDriftWhat the last reconcile found about a **platform-owned** record at the provider, or `null` when the provider agrees with us (the overwhelmingly common case). `changed` — a recor…

此端点可能返回的错误

401 · 403 · 404 · 409 · 422 · 429 · 502 · 503