hosting
PUT /v1/sites/{siteId}/cdn/security
Change a site's CDN security and bot settings.
認証
ベアラー トークンとして API キーを送信します。キーには hosting.cdn.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/cdn/security \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 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