hosting

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

Point a domain at this site's deploy target.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա hosting.deploy.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության 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…

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 404 · 422 · 429

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