hosting

PUT `/v1/sites/{siteId}/cdn/settings`

Change a site's CDN zone settings.

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 PUT https://api.zinndigital.com/v1/sites/{siteId}/cdn/settings \
  -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 are changed and an absent field is left alone — never reset to a default. A client written before a setting existed must not switch it off on every save. The body carries settings and nothing else. `additionalProperties: false` is load-bearing rather than tidy: these are pooled CDN accounts holding other customers' zones and a Cloudflare zone resolves **by name alone**, so a body key named `domain` or `zone_id` must be refused rather than silently discarded. The hostname is always read off the site row. `ssl_mode` deliberately does not accept Cloudflare's `flexible`, which leaves the edge-to-origin leg in plaintext. An empty body is a `422`, not a no-op success. A provider without these controls is a `422` with code `UNSUPPORTED_BY_PROVIDER` — a save that reported success having changed nothing would be worse than a refusal. 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 é
`cache_level`	`CdnCacheLevel`	Não	How aggressively the edge treats query strings as distinct cached objects, least to most. Cloudflare's `bypass` is deliberately not offered: it is an emergency operator state, a…
`development_mode`	`boolean`	Não	—
`always_online`	`boolean`	Não	—
`ssl_mode`	`CdnSslMode`	Não	The TLS leg between the edge and the origin. Cloudflare's `flexible` is deliberately absent — it leaves that leg in plaintext, and the platform's Cloudflare adapter refuses to b…
`brotli`	`boolean`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`site_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`supported`	`boolean`	Sim	Whether the CDN serving this site can express these settings at all. `false` for a pull-zone provider with no equivalent vocabulary; the other fields then carry defaults and a c…
`supported_values`	`object`	Sim	For an enumerated supported field, which values this provider can be set to. A field absent from this map takes every value in its own vocabulary — the common case, so the p…
`supported_fields`	`string[]`	Não	Which of the five settings this site's CDN can actually express. ⛔ Sent always and empty rather than omitted when there are none — a client reading absence as "all of them"…
`cache_level`	`CdnCacheLevelReported`	Sim	What a provider may REPORT for `cache_level` — the writable vocabulary plus the read-only states. `by_parameters` means the edge caches by a named list of query parameters c…
`development_mode`	`boolean`	Sim	Bypass the cache entirely so edits are visible immediately. The provider expires this automatically — see `development_mode_seconds_remaining`.
`development_mode_seconds_remaining`	`integer`	Sim	Seconds until the provider switches development mode off again, as reported by the provider rather than derived from when we set it. `0` when it is off. It is a countdown and no…
`always_online`	`boolean`	Sim	Serve an archived copy of the page when the origin is unreachable.
`ssl_mode`	`CdnSslMode`	Sim	The TLS leg between the edge and the origin. Cloudflare's `flexible` is deliberately absent — it leaves that leg in plaintext, and the platform's Cloudflare adapter refuses to b…
`brotli`	`boolean`	Sim	Serve Brotli-compressed responses to clients that accept them.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/sites/{siteId}/cdn/settings