hosting

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

Point a domain at this site's deploy target.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão hosting.deploy.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`siteId (path)`	`Uuid`	Sim	Site ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`hostname`	`string`	Sim	—
`write_dns`	`boolean`	Não	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.

Resposta

Nome	Tipo	Obrigatório	O que é
`hostname`	`string`	Sim	—
`is_primary`	`boolean`	Sim	—
`status`	`string<pending, active, failed>`	Sim	The provider's verdict on the binding.
`is_apex`	`boolean`	Sim	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>`	Sim	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`	Sim	—
`dns_vendor`	`string`	Sim	—
`dns_written_at`	`string`	Sim	—
`resolves`	`boolean`	Sim	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`	Sim	—
`last_check_detail`	`string`	Sim	—
`records`	`DnsRecordPlan[]`	Sim	—
`refusal`	`string`	Sim	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…

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429

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