hosting

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

Change a site's CDN zone settings.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن hosting.cdn.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/cdn/settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

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.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`siteId (path)`	`Uuid`	نعم	Site ID (UUIDv7).

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`cache_level`	`CdnCacheLevel`	لا	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, and…
`development_mode`	`boolean`	لا	—
`always_online`	`boolean`	لا	—
`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`	لا	—

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`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 · 422 · 429 · 502 · 503

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