hosting
GET /v1/sites/{siteId}/cdn/settings
Read a site's CDN zone settings.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/cdn/settings \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
supported | boolean | はい | 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… |
supported_values | object | はい | 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… |
supported_fields | string[] | いいえ | 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 | はい | 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… |
development_mode | boolean | はい | Bypass the cache entirely so edits are visible immediately. The provider expires this automatically — see development_mode_seconds_remaining. |
development_mode_seconds_remaining | integer | はい | 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 not… |
always_online | boolean | はい | Serve an archived copy of the page when the origin is unreachable. |
ssl_mode | CdnSslMode | はい | 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 be… |
brotli | boolean | はい | Serve Brotli-compressed responses to clients that accept them. |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 502 · 503