hosting

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

Read a site's CDN zone settings.

Alle hosting Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/cdn/settings \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

The edge behaviour a customer controls for their own zone: cache level, development mode, Always Online, the CDN-to-origin TLS mode, and Brotli compression. Read live from the provider on every call rather than mirrored, so the answer reflects what is actually in force — development mode in particular expires on the provider's own three-hour timer, and only the provider knows how much of it is left. A provider with no equivalent vocabulary (a pull-zone CDN such as Bunny or CDN77) answers `200` with `supported: false` and default values, **not** a `404` — the tier and cache-purge controls on the same screen are real on those providers and a `404` would take them down with it. A site that is not served through our CDN is a `404`, answered before any vendor call. A provider failure is a `503` that says the answer is unknown — never a `404`, which would tell a customer their site is not CDN-fronted because the vendor returned a 500. Requires `sites.view`.

Parameter

NameTypErforderlichWas es ist
siteId (path)UuidJaSite ID (UUIDv7).

Antwort

NameTypErforderlichWas es ist
site_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
supportedbooleanJaWhether 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_valuesobjectJaFor 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_fieldsstring[]NeinWhich 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_levelCdnCacheLevelReportedJaWhat 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_modebooleanJaBypass the cache entirely so edits are visible immediately. The provider expires this automatically — see `development_mode_seconds_remaining`.
development_mode_seconds_remainingintegerJaSeconds 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_onlinebooleanJaServe an archived copy of the page when the origin is unreachable.
ssl_modeCdnSslModeJaThe 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…
brotlibooleanJaServe Brotli-compressed responses to clients that accept them.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429 · 503