hosting
PUT /v1/sites/{siteId}/cdn/security
Change a site's CDN security and bot settings.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن hosting.cdn.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.
لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/cdn/security \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API
التفاصيل
A merge: only the fields present are changed. A full-object write would turn a customer's AI-crawler policy off every time they changed their security level. The body carries settings and nothing else — additionalProperties: false, for the reason PUT /v1/sites/{siteId}/cdn/settings gives: these are pooled CDN accounts and a Cloudflare zone resolves by name alone, so a body key named domain or zone_id must be refused rather than discarded. The result is read back from the provider rather than echoed, because the provider silently ignores a bot control a zone's plan does not include — "we asked" and "it changed" are different facts. Requires hosting.cdn.manage. Bot management is a sold entitlement (protection_tier). Turning bot_fight_mode on, or setting ai_bots_protection/crawler_protection to block or managed_challenge, needs a plan that includes it and otherwise answers a plan refusal naming the tier held and the tier needed. Three things are deliberately NOT gated. Turning any control off is free on every plan — a customer whose plan changed must always be able to reach the floor rather than be stranded with a setting they cannot undo. allow is an explicit relaxation, not protection, so it is free too. And security_level: under_attack is free on every plan, for ever: it is the emergency DDoS response, and refusing it to a customer under active attack because of their plan is not a product decision this platform will make.
المعلمات
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
siteId (path) | Uuid | نعم | Site ID (UUIDv7). |
جسم الطلب
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
security_level | CdnSecurityLevel | لا | The provider's own security-level vocabulary, passed through. Not ordered the way it reads — essentially_off sits between off and low — so nothing may treat it as a… |
bot_fight_mode | boolean | لا | — |
ai_bots_protection | CdnAiBotMode | لا | How the edge treats AI crawlers. disabled leaves them alone. This is the control on the screen most able to cost a site traffic, in either direction: blocking AI answer engines… |
crawler_protection | CdnAiBotMode | لا | How the edge treats AI crawlers. disabled leaves them alone. This is the control on the screen most able to cost a site traffic, in either direction: blocking AI answer engines… |
always_use_https | boolean | لا | — |
automatic_https_rewrites | boolean | لا | — |
opportunistic_encryption | boolean | لا | — |
min_tls_version | CdnMinTlsVersion | لا | The oldest TLS version the edge will negotiate. A string — 1.10 is not a version. |
الاستجابة
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
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 provider with no equivalent vocabulary; the other fields then carry defaults and a client should… |
unreadable | string[] | لا | Fields the CDN account's credential could not read, so their values here are defaults, not the zone's state. A client renders each listed control disabled and says it could not be… |
protection_tier | string | نعم | The protection level this organisation's plan sells (protection_tier). Absent from a plan means the floor — every site with a CDN already has the provider's baseline protection… |
bot_management_included | boolean | نعم | Whether that tier reaches bot management — enabling bot_fight_mode, or setting ai_bots_protection/crawler_protection to block or managed_challenge. Derived server-side… |
security_level | CdnSecurityLevel | نعم | The provider's own security-level vocabulary, passed through. Not ordered the way it reads — essentially_off sits between off and low — so nothing may treat it as a… |
bot_fight_mode | boolean | نعم | Challenge traffic the provider classifies as automated. Read from the provider's bot-management resource, not from a zone setting — the zone setting of that name does not exist. |
ai_bots_protection | CdnAiBotMode | نعم | How the edge treats AI crawlers. disabled leaves them alone. This is the control on the screen most able to cost a site traffic, in either direction: blocking AI answer engines… |
crawler_protection | CdnAiBotMode | نعم | How the edge treats AI crawlers. disabled leaves them alone. This is the control on the screen most able to cost a site traffic, in either direction: blocking AI answer engines… |
always_use_https | boolean | نعم | Redirect every plain-HTTP request to HTTPS at the edge. |
automatic_https_rewrites | boolean | نعم | Rewrite insecure sub-resource URLs in HTML to HTTPS where possible. |
opportunistic_encryption | boolean | نعم | Advertise HTTP/2 over TLS to clients that arrive over plain HTTP. |
min_tls_version | CdnMinTlsVersion | نعم | The oldest TLS version the edge will negotiate. A string — 1.10 is not a version. |
الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه
401 · 403 · 404 · 422 · 429 · 502 · 503