hosting
GET /v1/sites/{siteId}/cdn/security
Read a site's CDN security and bot settings.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/cdn/security \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
supported | boolean | Yes | 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 shou… |
protection_tier | string | Yes | 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 protectio… |
bot_management_included | boolean | Yes | 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 | Yes | 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 sc… |
bot_fight_mode | boolean | Yes | 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 | Yes | 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 engine… |
crawler_protection | CdnAiBotMode | Yes | 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 engine… |
always_use_https | boolean | Yes | Redirect every plain-HTTP request to HTTPS at the edge. |
automatic_https_rewrites | boolean | Yes | Rewrite insecure sub-resource URLs in HTML to HTTPS where possible. |
opportunistic_encryption | boolean | Yes | Advertise HTTP/2 over TLS to clients that arrive over plain HTTP. |
min_tls_version | CdnMinTlsVersion | Yes | The oldest TLS version the edge will negotiate. A string — `1.10` is not a version. |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503