hosting
GET /v1/sites/{siteId}/cdn/security
Read a site's CDN security and bot settings.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/cdn/security \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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_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 · 429 · 502 · 503