hosting

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

Read a site's CDN security and bot settings.

جميع نقاط نهاية hosting

جميع مستندات المطورين

المصادقة

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

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

جربه الآن

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

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

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

التفاصيل

How hard the edge is on suspicious traffic, and how it treats AI crawlers: security level, bot fight mode, Cloudflare's AI-bot and crawler controls, Always Use HTTPS, automatic HTTPS rewrites, opportunistic encryption and the minimum TLS version. Separate from /cdn/settings, which is about caching and the origin TLS leg, because these are a different question with a different blast radius — turning the cache off makes a site slow, while under_attack puts an interstitial in front of every visitor and crawler_protection can remove a site from search results. They are also different provider APIs behind different token scopes, so a customer's own credential may carry one and not the other. A provider with no equivalent vocabulary answers 200 with supported: false and defaults, never a 404. 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 provider with no equivalent vocabulary; the other fields then carry defaults and a client should…
unreadablestring[]لا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_tierstringنعم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_includedbooleanنعم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_levelCdnSecurityLevelنعمThe provider's own security-level vocabulary, passed through. Not ordered the way it readsessentially_off sits between off and low — so nothing may treat it as a…
bot_fight_modebooleanنعم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_protectionCdnAiBotModeنعم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_protectionCdnAiBotModeنعم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_httpsbooleanنعمRedirect every plain-HTTP request to HTTPS at the edge.
automatic_https_rewritesbooleanنعمRewrite insecure sub-resource URLs in HTML to HTTPS where possible.
opportunistic_encryptionbooleanنعمAdvertise HTTP/2 over TLS to clients that arrive over plain HTTP.
min_tls_versionCdnMinTlsVersionنعمThe oldest TLS version the edge will negotiate. A string — 1.10 is not a version.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 429 · 502 · 503