hosting
PUT /v1/sites/{siteId}/cdn/security
Change a site's CDN security and bot settings.
Authentication
Send an API key as a bearer token. The key must carry the hosting.cdn.manage 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 PUT https://api.zinndigital.com/v1/sites/{siteId}/cdn/security \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
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. Bot Fight Mode is opt-in. The platform never switches it on, and it can challenge automated traffic a site depends on — uptime monitors, payment callbacks and some crawlers. Switching it on for a site the platform itself runs answers 422 before anything reaches the provider. Every field is zone-wide. A site on a shared preview address is served by a zone every other preview site uses, so a write for it answers 422 before anything reaches the provider.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
security_level | CdnSecurityLevel | No | 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 | No | — |
ai_bots_protection | CdnAiBotMode | No | 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 | CdnCrawlerProtectionMode | No | Whether the edge challenges ordinary crawlers. A two-value switch, not the four-mode AI-crawler vocabulary — the provider answers 400 for block, managed_challenge and… |
always_use_https | boolean | No | — |
automatic_https_rewrites | boolean | No | — |
opportunistic_encryption | boolean | No | — |
min_tls_version | CdnMinTlsVersion | No | The oldest TLS version the edge will negotiate. A string — 1.10 is not a version. |
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 should… |
unreadable | string[] | No | 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… |
flood_hold_until | object | No | s1014 L04. While the flood guard holds this site's zone in Under Attack, the earliest it may lift it (the hold restarts on every pass that still sees the flood); null when it… |
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 protection… |
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… |
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 engines… |
crawler_protection | CdnCrawlerProtectionMode | Yes | Whether the edge challenges ordinary crawlers. A two-value switch, not the four-mode AI-crawler vocabulary — the provider answers 400 for block, managed_challenge and… |
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 · 409 · 422 · 429 · 502 · 503