hosting

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

Point a domain at this site's deploy target.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya hosting.deploy.manage; ufunguo usio nayo unakataliwa kwa 403, si 404.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`siteId (path)`	`Uuid`	Ndiyo	Site ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`hostname`	`string`	Ndiyo	—
`write_dns`	`boolean`	Hapana	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.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`hostname`	`string`	Ndiyo	—
`is_primary`	`boolean`	Ndiyo	—
`status`	`string<pending, active, failed>`	Ndiyo	The provider's verdict on the binding.
`is_apex`	`boolean`	Ndiyo	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>`	Ndiyo	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`	Ndiyo	—
`dns_vendor`	`string`	Ndiyo	—
`dns_written_at`	`string`	Ndiyo	—
`resolves`	`boolean`	Ndiyo	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`	Ndiyo	—
`last_check_detail`	`string`	Ndiyo	—
`records`	`DnsRecordPlan[]`	Ndiyo	—
`refusal`	`string`	Ndiyo	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…

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422 · 429

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