hosting
POST /v1/sites/{siteId}/edge-domains
Point a domain at this site's deploy target.
認証
ベアラー トークンとして API キーを送信します。キーには hosting.deploy.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/edge-domains \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "hostname": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Attaches the hostname at the provider and, unless `write_dns` is false, publishes its DNS records in the same call — on the customer's own connected DNS account where they have one, otherwise on ours. A DNS failure does not fail the bind: the binding at the provider has already happened, and reporting failure would leave the customer retrying into an "already bound" error. The DNS outcome is on the returned row instead. Requires `hosting.deploy.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
hostname | string | はい | — |
write_dns | boolean | いいえ | Publish the DNS records in the same call. Defaults to true because doing the DNS for the customer is the point of this surface; opting out is the unusual request. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
hostname | string | はい | — |
is_primary | boolean | はい | — |
status | string<pending, active, failed> | はい | The provider's verdict on the binding. |
is_apex | boolean | はい | Whether this hostname is the zone apex. An apex cannot hold a CNAME, so its record set is provider-specific and sometimes impossible — see `refusal`. |
dns_mode | string<unknown, our_zone, byo_dns, nameservers, manual> | はい | Which DNS tier this hostname landed on. `unknown` means nothing has been attempted yet and must not be rendered as "no action needed". |
dns_zone | string | はい | — |
dns_vendor | string | はい | — |
dns_written_at | string | はい | — |
resolves | boolean | はい | Three-valued. `true` every wanted record is live, `false` at least one answered and is wrong, `null` no check has answered. `null` is not `false`. |
last_checked_at | string | はい | — |
last_check_detail | string | はい | — |
records | DnsRecordPlan[] | はい | — |
refusal | string | はい | Non-empty when no valid record set exists for this hostname at this provider — today, a Cloudflare Pages apex on a zone that is not on Cloudflare DNS, because that provider publ… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429