hosting

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

Read a site's CDN zone settings.

همه نقاط پایانی hosting

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

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

پارامترها

نامنوعالزامیچیست
siteId (path)UuidبلهSite ID (UUIDv7).

پاسخ

نامنوعالزامیچیست
site_idUuidبلهUUIDv7 identifier — sortable by creation time (docs/02 §8).
supportedbooleanبله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_valuesobjectبله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_fieldsstring[]خیر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_levelCdnCacheLevelReportedبله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_modebooleanبلهBypass the cache entirely so edits are visible immediately. The provider expires this automatically — see `development_mode_seconds_remaining`.
development_mode_seconds_remainingintegerبله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_onlinebooleanبلهServe an archived copy of the page when the origin is unreachable.
ssl_modeCdnSslModeبله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…
brotlibooleanبلهServe Brotli-compressed responses to clients that accept them.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 429 · 503