hosting

POST `/v1/sites/{siteId}/edge-domains`

Point a domain at this site's deploy target.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл hosting.deploy.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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 у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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

POST /v1/sites/{siteId}/edge-domains