hosting

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

Read a site's CDN zone settings.

Wszystkie punkty końcowe hosting

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).

Odpowiedź

NazwaTypWymaganeCo to jest
site_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
supportedbooleanTakWhether 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…
supported_valuesobjectTakFor 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…
supported_fieldsstring[]NieWhich 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_levelCdnCacheLevelReportedTakWhat 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
development_modebooleanTakBypass the cache entirely so edits are visible immediately. The provider expires this automatically — see development_mode_seconds_remaining.
development_mode_seconds_remainingintegerTakSeconds 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 not…
always_onlinebooleanTakServe an archived copy of the page when the origin is unreachable.
ssl_modeCdnSslModeTakThe 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 be…
brotlibooleanTakServe Brotli-compressed responses to clients that accept them.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429 · 502 · 503