hosting

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

Point a domain at this site's deploy target.

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione hosting.deploy.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`siteId (path)`	`Uuid`	Sì	Site ID (UUIDv7).

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`hostname`	`string`	Sì	—
`write_dns`	`boolean`	No	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.

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`hostname`	`string`	Sì	—
`is_primary`	`boolean`	Sì	—
`status`	`string<pending, active, failed>`	Sì	The provider's verdict on the binding.
`is_apex`	`boolean`	Sì	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>`	Sì	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`	Sì	—
`dns_vendor`	`string`	Sì	—
`dns_written_at`	`string`	Sì	—
`resolves`	`boolean`	Sì	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`	Sì	—
`last_check_detail`	`string`	Sì	—
`records`	`DnsRecordPlan[]`	Sì	—
`refusal`	`string`	Sì	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…

Errori che questo endpoint può restituire

401 · 403 · 404 · 422 · 429

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