domains
POST /v1/domains/{domainId}/dns/records
Create a DNS record.
認証
ベアラー トークンとして API キーを送信します。キーには domains.dns.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/dns/records \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "type": <DnsRecordType>, "value": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Adds a record to the domain's hosted zone. Requires domains.dns.manage. On the Footprint-Free line an A/AAAA record (or a CNAME to an IP literal, which resolves to one) is refused with a 422 — those are platform-managed. Adding an apex MX is not additive (issue #622). MX preference is lowest-number-wins, so a new record at or below the best existing preference takes delivery away from the host the customer's mail reaches today, without removing its record. That is refused 409 MAIL_CHANGE_REFUSED unless confirm_mail_change=true; a strictly higher preference number is an ordinary backup MX and is allowed, as is the first MX on a domain that has none.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
domainId (path) | Uuid | はい | The domain's id. |
confirm_mail_change (query) | boolean | いいえ | Set 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 today… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
name | string | はい | The record name — @/empty for the apex, or a relative/absolute host. |
type | DnsRecordType | はい | A DNS resource-record type the shared editor supports (docs/31 §5.2). |
value | string | はい | — |
ttl | integer | いいえ | — |
priority | object | いいえ | — |
proxied | object | いいえ | Serve 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,… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | string | はい | The provider-assigned record id. |
name | string | はい | The record name — @ for the apex, or a relative/absolute host. |
type | DnsRecordType | はい | A DNS resource-record type the shared editor supports (docs/31 §5.2). |
value | string | はい | The record value (target/content). |
ttl | integer | はい | Time-to-live in seconds. |
priority | object | いいえ | Priority for MX/SRV records; null otherwise. |
proxied | object | いいえ | Whether 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. ⛔⛔… |
owner | DnsRecordOwner | はい | Who 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 it.… |
drift | DnsRecordDrift | いいえ | What 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 record… |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 502 · 503