hosting

PATCH `/v1/sites/{siteId}/cdn/canonical-host`

Choose www or non-www, and whether to force HTTPS.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão hosting.cdn.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 PATCH https://api.zinndigital.com/v1/sites/{siteId}/cdn/canonical-host \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

A **merge**: only the fields present in the body change. An absent field is left alone rather than reset, so a client written before one of these existed cannot switch it off on every save. `force_https` defaults to `true` on every new site. The insecure choice has to be made explicitly; it is never reached by omitting a field. A site whose primary domain is a **deeper subdomain** (`shop.blog.example.com`) has no `www` counterpart, and the request is a `422` rather than a stored preference whose plan can never be built. Refusing at write time is deliberate: the alternative saves cleanly and then fails later inside provisioning, where the customer sees a stuck deploy instead of the bad input. An empty body is a `422`, not a no-op success. Requires `hosting.cdn.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 é
`canonical_host`	`string<apex, www>`	Não	—
`force_https`	`boolean`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`canonical_host`	`string<apex, www>`	Sim	—
`force_https`	`boolean`	Sim	Redirect http to https at the edge. Defaults to true on every new site.
`serves_on`	`string`	Sim	The hostname that actually serves.
`redirects_from`	`string`	Sim	The hostname that permanently redirects to `serves_on`.
`redirect_status`	`integer`	Sim	Always 301. A 302 tells search engines to keep indexing the alias, which leaves the duplicate-content problem unsolved while looking correct in a browser.
`certificate_hosts`	`string[]`	Sim	Both hostnames, always. TLS is negotiated on the name being redirected from, so a certificate covering only `serves_on` puts a security interstitial in front of the alias an…
`apex_delivery`	`string<native, alias, a_records, unsupported>`	Sim	How the zone apex is made to resolve. A bare apex cannot be a `CNAME`, so on a pull-zone CDN it resolves only through CNAME-flattening/ALIAS at the DNS provider, or through A/AA…
`apex_deliverable`	`boolean`	Sim	`false` when neither mechanism is available for this CDN/DNS pairing. The combination is refused rather than accepted, because the alternative provisions cleanly, reports health…

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429

PATCH /v1/sites/{siteId}/cdn/canonical-host