hosting

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

Point a domain at this site's deploy target.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie hosting.deploy.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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`.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`siteId (path)`	`Uuid`	Tak	Site ID (UUIDv7).

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`hostname`	`string`	Tak	—
`write_dns`	`boolean`	Nie	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.

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`hostname`	`string`	Tak	—
`is_primary`	`boolean`	Tak	—
`status`	`string<pending, active, failed>`	Tak	The provider's verdict on the binding.
`is_apex`	`boolean`	Tak	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>`	Tak	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`	Tak	—
`dns_vendor`	`string`	Tak	—
`dns_written_at`	`string`	Tak	—
`resolves`	`boolean`	Tak	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`	Tak	—
`last_check_detail`	`string`	Tak	—
`records`	`DnsRecordPlan[]`	Tak	—
`refusal`	`string`	Tak	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…

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429

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