--- title: Zones --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Zones ##### [List Zones](https://developers.cloudflare.com/api/python/resources/zones/methods/list) zones.list(ZoneListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Zone]()] GET/zones ##### [Zone Details](https://developers.cloudflare.com/api/python/resources/zones/methods/get) zones.get(ZoneGetParams\*\*kwargs) -> [Zone]() GET/zones/{zone\_id} ##### [Create Zone](https://developers.cloudflare.com/api/python/resources/zones/methods/create) zones.create(ZoneCreateParams\*\*kwargs) -> [Zone]() POST/zones ##### [Edit Zone](https://developers.cloudflare.com/api/python/resources/zones/methods/edit) zones.edit(ZoneEditParams\*\*kwargs) -> [Zone]() PATCH/zones/{zone\_id} ##### [Delete Zone](https://developers.cloudflare.com/api/python/resources/zones/methods/delete) zones.delete(ZoneDeleteParams\*\*kwargs) -> [ZoneDeleteResponse]() DELETE/zones/{zone\_id} ##### ModelsExpand Collapse
Literal\["full", "partial", "secondary", "internal"] A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. One of the following: "full" Link to this property "partial" Link to this property "secondary" Link to this property "internal" Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(model)%20type%20%3E%20(schema)>)
class Zone: … id: str Identifier maxLength32 Link to this property
account: Account The account the zone belongs to. id: Optional\[str] Identifier maxLength32 Link to this property name: Optional\[str] The name of the account. Link to this property
Link to this property activated\_on: Optional\[datetime] The last time proof of ownership was detected and the zone was made active. formatdate-time Link to this property created\_on: datetime When the zone was created. formatdate-time Link to this property development\_mode: float The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is 0. Link to this property
meta: Meta Metadata about the zone. cdn\_only: Optional\[bool] The zone is only configured for CDN. Link to this property custom\_certificate\_quota: Optional\[int] Number of Custom Certificates the zone can have. Link to this property dns\_only: Optional\[bool] The zone is only configured for DNS. Link to this property foundation\_dns: Optional\[bool] The zone is setup with Foundation DNS. Link to this property page\_rule\_quota: Optional\[int] Number of Page Rules a zone can have. Link to this property phishing\_detected: Optional\[bool] The zone has been flagged for phishing. Link to this property step: Optional\[int] Link to this property
Link to this property modified\_on: datetime When the zone was last modified. formatdate-time Link to this property name: str The domain name. Per RFC 1035 the overall zone name can be up to 253 characters, with each segment (“label”) not exceeding 63 characters. maxLength253 Link to this property name\_servers: List\[str] The name servers Cloudflare assigns to a zone. Link to this property original\_dnshost: Optional\[str] DNS host at the time of switching to Cloudflare. maxLength50 Link to this property original\_name\_servers: Optional\[List\[str]] Original name servers before moving to Cloudflare. Link to this property original\_registrar: Optional\[str] Registrar for the domain at the time of switching to Cloudflare. Link to this property
owner: Owner The owner of the zone. id: Optional\[str] Identifier maxLength32 Link to this property name: Optional\[str] Name of the owner. Link to this property type: Optional\[str] The type of owner. Link to this property
Link to this property
Deprecatedplan: Plan Please use the /zones/{zone_id}/subscription API to update a zone’s plan. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans. A Zones subscription information. id: Optional\[str] Identifier maxLength32 Link to this property can\_subscribe: Optional\[bool] States if the subscription can be activated. Link to this property currency: Optional\[str] The denomination of the customer. Link to this property externally\_managed: Optional\[bool] If this Zone is managed by another company. Link to this property frequency: Optional\[str] How often the customer is billed. Link to this property is\_subscribed: Optional\[bool] States if the subscription active. Link to this property legacy\_discount: Optional\[bool] If the legacy discount applies to this Zone. Link to this property legacy\_id: Optional\[str] The legacy name of the plan. Link to this property name: Optional\[str] Name of the owner. Link to this property price: Optional\[float] How much the customer is paying. Link to this property
Link to this property cname\_suffix: Optional\[str] Allows the customer to use a custom apex. *Tenants Only Configuration*. Link to this property paused: Optional\[bool] Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits. Link to this property Deprecatedpermissions: Optional\[List\[str]] This has been replaced by Account memberships. Legacy permissions based on legacy user membership information. Link to this property
status: Optional\[Literal\["initializing", "pending", "active", "moved"]] The zone status on Cloudflare. One of the following: "initializing" Link to this property "pending" Link to this property "active" Link to this property "moved" Link to this property
Link to this property
tenant: Optional\[Tenant] The root organizational unit that this zone belongs to (such as a tenant or organization). id: Optional\[str] Identifier maxLength32 Link to this property name: Optional\[str] The name of the Tenant account. Link to this property
Link to this property
tenant\_unit: Optional\[TenantUnit] The immediate parent organizational unit that this zone belongs to (such as under a tenant or sub-organization). id: Optional\[str] Identifier maxLength32 Link to this property
Link to this property type: Optional\[Type] A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. Link to this property vanity\_name\_servers: Optional\[List\[str]] An array of domains used for custom name servers. This is only available for Business and Enterprise plans. Link to this property verification\_key: Optional\[str] Verification key for partial zone setup. Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(model)%20zone%20%3E%20(schema)>)
class ZoneDeleteResponse: … id: str Identifier maxLength32 Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(model)%20zone_delete_response%20%3E%20(schema)>) #### ZonesActivation Check ##### [Rerun the Activation Check](https://developers.cloudflare.com/api/python/resources/zones/subresources/activation_check/methods/trigger) zones.activation\_check.trigger(ActivationCheckTriggerParams\*\*kwargs) -> [ActivationCheckTriggerResponse]() PUT/zones/{zone\_id}/activation\_check ##### ModelsExpand Collapse
class ActivationCheckTriggerResponse: … id: Optional\[str] Identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20zones.activation_check%20%3E%20(model)%20activation_check_trigger_response%20%3E%20(schema)>) #### ZonesObservability #### ZonesObservabilityTracing #### ZonesObservabilityTracingSettings ##### [View zone tracing settings](https://developers.cloudflare.com/api/python/resources/zones/subresources/observability/subresources/tracing/subresources/settings/methods/get) zones.observability.tracing.settings.get(SettingGetParams\*\*kwargs) -> [SettingGetResponse]() GET/zones/{zone\_id}/observability/tracing/settings ##### [Update zone tracing settings](https://developers.cloudflare.com/api/python/resources/zones/subresources/observability/subresources/tracing/subresources/settings/methods/update) zones.observability.tracing.settings.update(SettingUpdateParams\*\*kwargs) -> [SettingUpdateResponse]() PATCH/zones/{zone\_id}/observability/tracing/settings ##### [Reset zone tracing settings](https://developers.cloudflare.com/api/python/resources/zones/subresources/observability/subresources/tracing/subresources/settings/methods/delete) zones.observability.tracing.settings.delete(SettingDeleteParams\*\*kwargs) -> [SettingDeleteResponse]() DELETE/zones/{zone\_id}/observability/tracing/settings ##### ModelsExpand Collapse
class SettingGetResponse: … destinations: List\[str] Up to 100 OpenTelemetry destination identifiers that receive traces. Link to this property enabled: bool Whether Cloudflare Traces is enabled for the zone. Link to this property forward\_context: bool Whether trace context is sent externally or across a zone boundary. Link to this property persist: bool Whether traces are persisted in Cloudflare. Link to this property
propagation\_policy: Literal\["accept", "authenticated", "reject"] When inbound trace context may be continued. Authenticated propagation is not supported yet. One of the following: "accept" Link to this property "authenticated" Link to this property "reject" Link to this property
Link to this property sampling\_ratio: float The ratio of requests sampled for tracing, from 0 to 1. maximum1 minimum0 Link to this property
[Link to this property](<#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)>)
class SettingUpdateResponse: … destinations: List\[str] Up to 100 OpenTelemetry destination identifiers that receive traces. Link to this property enabled: bool Whether Cloudflare Traces is enabled for the zone. Link to this property forward\_context: bool Whether trace context is sent externally or across a zone boundary. Link to this property persist: bool Whether traces are persisted in Cloudflare. Link to this property
propagation\_policy: Literal\["accept", "authenticated", "reject"] When inbound trace context may be continued. Authenticated propagation is not supported yet. One of the following: "accept" Link to this property "authenticated" Link to this property "reject" Link to this property
Link to this property sampling\_ratio: float The ratio of requests sampled for tracing, from 0 to 1. maximum1 minimum0 Link to this property
[Link to this property](<#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)>)
class SettingDeleteResponse: … destinations: List\[str] Up to 100 OpenTelemetry destination identifiers that receive traces. Link to this property enabled: bool Whether Cloudflare Traces is enabled for the zone. Link to this property forward\_context: bool Whether trace context is sent externally or across a zone boundary. Link to this property persist: bool Whether traces are persisted in Cloudflare. Link to this property
propagation\_policy: Literal\["accept", "authenticated", "reject"] When inbound trace context may be continued. Authenticated propagation is not supported yet. One of the following: "accept" Link to this property "authenticated" Link to this property "reject" Link to this property
Link to this property sampling\_ratio: float The ratio of requests sampled for tracing, from 0 to 1. maximum1 minimum0 Link to this property
[Link to this property](<#(resource)%20zones.observability.tracing.settings%20%3E%20(model)%20setting_delete_response%20%3E%20(schema)>) #### ZonesObservabilityTracingRules ##### [View zone trace rules](https://developers.cloudflare.com/api/python/resources/zones/subresources/observability/subresources/tracing/subresources/rules/methods/get) zones.observability.tracing.rules.get(RuleGetParams\*\*kwargs) -> [RuleGetResponse]() GET/zones/{zone\_id}/observability/tracing/rules ##### [Replace zone trace rules](https://developers.cloudflare.com/api/python/resources/zones/subresources/observability/subresources/tracing/subresources/rules/methods/update) zones.observability.tracing.rules.update(RuleUpdateParams\*\*kwargs) -> [RuleUpdateResponse]() PUT/zones/{zone\_id}/observability/tracing/rules ##### [Delete zone trace rules](https://developers.cloudflare.com/api/python/resources/zones/subresources/observability/subresources/tracing/subresources/rules/methods/delete) zones.observability.tracing.rules.delete(RuleDeleteParams\*\*kwargs) -> [RuleDeleteResponse]() DELETE/zones/{zone\_id}/observability/tracing/rules ##### ModelsExpand Collapse
class RuleGetResponse: …
rules: List\[Rule] Trace rules in evaluation order. action: Literal\["set\_trace\_settings"] Link to this property
action\_parameters: RuleActionParameters sampling\_ratio: float The ratio of requests sampled for tracing, from 0 to 1. maximum1 minimum0 Link to this property
Link to this property description: str maxLength1000 Link to this property enabled: bool Link to this property expression: str A Rules language expression that selects requests. maxLength4096 minLength1 Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)>)
class RuleUpdateResponse: …
rules: List\[Rule] Trace rules in evaluation order. action: Literal\["set\_trace\_settings"] Link to this property
action\_parameters: RuleActionParameters sampling\_ratio: float The ratio of requests sampled for tracing, from 0 to 1. maximum1 minimum0 Link to this property
Link to this property description: str maxLength1000 Link to this property enabled: bool Link to this property expression: str A Rules language expression that selects requests. maxLength4096 minLength1 Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)>)
class RuleDeleteResponse: …
rules: List\[Rule] Trace rules in evaluation order. action: Literal\["set\_trace\_settings"] Link to this property
action\_parameters: RuleActionParameters sampling\_ratio: float The ratio of requests sampled for tracing, from 0 to 1. maximum1 minimum0 Link to this property
Link to this property description: str maxLength1000 Link to this property enabled: bool Link to this property expression: str A Rules language expression that selects requests. maxLength4096 minLength1 Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.observability.tracing.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>) #### ZonesSettings ##### [Get zone setting](https://developers.cloudflare.com/api/python/resources/zones/subresources/settings/methods/get) zones.settings.get(strsetting\_id, SettingGetParams\*\*kwargs) -> [SettingGetResponse]() GET/zones/{zone\_id}/settings/{setting\_id} ##### [Edit zone setting](https://developers.cloudflare.com/api/python/resources/zones/subresources/settings/methods/edit) zones.settings.edit(strsetting\_id, SettingEditParams\*\*kwargs) -> [SettingEditResponse]() PATCH/zones/{zone\_id}/settings/{setting\_id} ##### ModelsExpand Collapse
class AdvancedDDoS: … Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is ‘on’ in the case of Business and Enterprise zones. id: Literal\["advanced\_ddos"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20advanced_ddos%20%3E%20(schema)>)
class AlwaysOnline: … When enabled, Cloudflare serves limited copies of web pages available from the Internet Archive’s Wayback Machine if your server is offline. Refer to Always Online for more information. id: Literal\["always\_online"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20always_online%20%3E%20(schema)>)
class AlwaysUseHTTPS: … id: Optional\[Literal\["always\_use\_https"]] If enabled, any http://`` URL is converted to https://\` through a 301 redirect. Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20always_use_https%20%3E%20(schema)>)
class AutomaticHTTPSRewrites: … id: Optional\[Literal\["automatic\_https\_rewrites"]] Turn on or off Automatic HTTPS Rewrites. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Automatic HTTPS Rewrites. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20automatic_https_rewrites%20%3E%20(schema)>)
class AutomaticPlatformOptimization: … cache\_by\_device\_type: bool Indicates whether or not cache by device type is enabled. Link to this property cf: bool Indicates whether or not Cloudflare proxy is enabled. Link to this property enabled: bool Indicates whether or not Automatic Platform Optimization is enabled. Link to this property hostnames: List\[str] An array of hostnames where Automatic Platform Optimization for WordPress is activated. Link to this property wordpress: bool Indicates whether or not site is powered by WordPress. Link to this property wp\_plugin: bool Indicates whether or not Cloudflare for WordPress plugin is installed. Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20automatic_platform_optimization%20%3E%20(schema)>)
class Brotli: … When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. id: Literal\["brotli"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20brotli%20%3E%20(schema)>)
class BrowserCacheTTL: … id: Optional\[Literal\["browser\_cache\_ttl"]] Control how long resources cached by client browsers remain valid. Link to this property value: Optional\[int] The number of seconds to cache resources for. Setting this to 0 enables “Respect Existing Headers”. maximum31536000 minimum0 Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20browser_cache_ttl%20%3E%20(schema)>)
class BrowserCheck: … id: Optional\[Literal\["browser\_check"]] Inspect the visitor’s browser for headers commonly associated with spammers and certain bots. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Browser Integrity Check. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20browser_check%20%3E%20(schema)>)
class CacheLevel: … id: Optional\[Literal\["cache\_level"]] Apply custom caching based on the option selected. Link to this property
value: Optional\[Literal\["bypass", "basic", "simplified", 2 more]] - bypass: Cloudflare does not cache. - basic: Delivers resources from cache when there is no query string. - simplified: Delivers the same resource to everyone independent of the query string. - aggressive: Caches all static content that has a query string. - cache_everything: Treats all content as static and caches all file types beyond the Cloudflare default cached content. One of the following: "bypass" Link to this property "basic" Link to this property "simplified" Link to this property "aggressive" Link to this property "cache\_everything" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20cache_level%20%3E%20(schema)>)
class ChallengeTTL: … Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). id: Literal\["challenge\_ttl"] ID of the zone setting. Link to this property
value: Literal\[300, 900, 1800, 11 more] Current value of the zone setting. One of the following: 300 Link to this property 900 Link to this property 1800 Link to this property 2700 Link to this property 3600 Link to this property 7200 Link to this property 10800 Link to this property 14400 Link to this property 28800 Link to this property 57600 Link to this property 86400 Link to this property 604800 Link to this property 2592000 Link to this property 31536000 Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20challenge_ttl%20%3E%20(schema)>)
class Ciphers: … An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. id: Literal\["ciphers"] ID of the zone setting. Link to this property value: List\[str] Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20ciphers%20%3E%20(schema)>)
class DevelopmentMode: … Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare’s accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. id: Literal\["development\_mode"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property time\_remaining: Optional\[float] Value of the zone setting. Notes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false. Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20development_mode%20%3E%20(schema)>)
class EarlyHints: … When enabled, Cloudflare will attempt to speed up overall page loads by serving 103 responses with Link headers from the final response. Refer to Early Hints for more information. id: Literal\["early\_hints"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20early_hints%20%3E%20(schema)>)
class EmailObfuscation: … id: Optional\[Literal\["email\_obfuscation"]] Turn on or off **Email Obfuscation**. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Email Obfuscation. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20email_obfuscation%20%3E%20(schema)>)
class FontSettings: … Enhance your website’s font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information. id: Optional\[Literal\["fonts"]] ID of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
value: Optional\[Literal\["on", "off"]] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20font_settings%20%3E%20(schema)>)
class H2Prioritization: … HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. id: Literal\["h2\_prioritization"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "custom"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "custom" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20h2_prioritization%20%3E%20(schema)>)
class HotlinkProtection: … When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it’s not another site requesting them. People will still be able to download and view images from your page, but other sites won’t be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). id: Literal\["hotlink\_protection"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20hotlink_protection%20%3E%20(schema)>)
class HTTP2: … HTTP2 enabled for this zone. id: Literal\["http2"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20http2%20%3E%20(schema)>)
class HTTP3: … HTTP3 enabled for this zone. id: Literal\["http3"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20http3%20%3E%20(schema)>)
class ImageResizing: … Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare’s network. Refer to the Image Transformations documentation for more information. id: Literal\["image\_resizing"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "open"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "open" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20image_resizing%20%3E%20(schema)>)
class IPGeolocation: … id: Optional\[Literal\["ip\_geolocation"]] Cloudflare adds a CF-IPCountry HTTP header containing the country code that corresponds to the visitor. Link to this property
value: Optional\[Literal\["on", "off"]] The status of adding the IP Geolocation Header. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20ip_geolocation%20%3E%20(schema)>)
class IPV6: … Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). id: Literal\["ipv6"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20ipv6%20%3E%20(schema)>)
class MinTLSVersion: … Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. id: Literal\["min\_tls\_version"] ID of the zone setting. Link to this property
value: Literal\["1.0", "1.1", "1.2", "1.3"] Current value of the zone setting. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20min_tls_version%20%3E%20(schema)>)
class Mirage: … id: Optional\[Literal\["mirage"]] Cloudflare Mirage reduces bandwidth used by images in mobile browsers. It can accelerate loading of image-heavy websites on very slow mobile connections and HTTP/1. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Mirage. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20mirage%20%3E%20(schema)>)
class NEL: … Enable Network Error Logging reporting on your zone. (Beta) id: Literal\["nel"] Zone setting identifier. Link to this property
value: Value Current value of the zone setting. enabled: Optional\[bool] Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20nel%20%3E%20(schema)>)
class OpportunisticEncryption: … id: Optional\[Literal\["opportunistic\_encryption"]] Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted TLS channel. It’s not a substitute for HTTPS, but provides additional security for otherwise vulnerable requests. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Opportunistic Encryption. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20opportunistic_encryption%20%3E%20(schema)>)
class OpportunisticOnion: … Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. id: Literal\["opportunistic\_onion"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20opportunistic_onion%20%3E%20(schema)>)
class OrangeToOrange: … Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. id: Literal\["orange\_to\_orange"] ID of the zone setting. Link to this property
Deprecatedvalue: Literal\["on", "off"] This setting is deprecated. Orange to Orange (O2O) is applied automatically for eligible zones and no longer requires configuration; this setting only controlled the legacy O2O v1 (Managed CNAME) path. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/ Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20orange_to_orange%20%3E%20(schema)>)
class OriginErrorPagePassThru: … id: Optional\[Literal\["origin\_error\_page\_pass\_thru"]] Turn on or off Cloudflare error pages generated from issues sent from the origin server. If enabled, this setting triggers error pages issued by the origin. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Origin Error Page Passthru. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20origin_error_page_pass_thru%20%3E%20(schema)>)
class OriginMaxHTTPVersion: … id: Literal\["origin\_max\_http\_version"] The identifier of the caching setting. Link to this property editable: bool Whether the setting is editable. Link to this property
value: Literal\["2", "1"] Value of the Origin Max HTTP Version Setting. One of the following: "2" Link to this property "1" Link to this property
Link to this property modified\_on: Optional\[datetime] Last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20origin_max_http_version%20%3E%20(schema)>)
class Polish: … id: Optional\[Literal\["polish"]] Apply options from the Polish feature of the Cloudflare Speed app. Link to this property
value: Optional\[Literal\["off", "lossless", "lossy"]] The level of Polish you want applied to your origin. One of the following: "off" Link to this property "lossless" Link to this property "lossy" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20polish%20%3E%20(schema)>)
class PrefetchPreload: … Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. id: Literal\["prefetch\_preload"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20prefetch_preload%20%3E%20(schema)>)
class ProxyReadTimeout: … Maximum time between two read operations from origin. id: Literal\["proxy\_read\_timeout"] ID of the zone setting. Link to this property value: float Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20proxy_read_timeout%20%3E%20(schema)>)
class PseudoIPV4: … The value set for the Pseudo IPv4 setting. id: Literal\["pseudo\_ipv4"] Value of the Pseudo IPv4 setting. Link to this property
value: Literal\["off", "add\_header", "overwrite\_header"] Current value of the zone setting. One of the following: "off" Link to this property "add\_header" Link to this property "overwrite\_header" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20pseudo_ipv4%20%3E%20(schema)>)
class ResponseBuffering: … id: Optional\[Literal\["response\_buffering"]] Turn on or off whether Cloudflare should wait for an entire file from the origin server before forwarding it to the site visitor. By default, Cloudflare sends packets to the client as they arrive from the origin server. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Response Buffering One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20response_buffering%20%3E%20(schema)>)
class RocketLoader: … id: Optional\[Literal\["rocket\_loader"]] Turn on or off Rocket Loader in the Cloudflare Speed app. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Rocket Loader One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20rocket_loader%20%3E%20(schema)>)
class SecurityHeaders: … Cloudflare security header for a zone. id: Literal\["security\_header"] ID of the zone’s security header. Link to this property
value: Value Current value of the zone setting.
strict\_transport\_security: Optional\[ValueStrictTransportSecurity] Strict Transport Security. enabled: Optional\[bool] Whether or not strict transport security is enabled. Link to this property include\_subdomains: Optional\[bool] Include all subdomains for strict transport security. Link to this property max\_age: Optional\[float] Max age in seconds of the strict transport security. Link to this property nosniff: Optional\[bool] Whether or not to include ‘X-Content-Type-Options: nosniff’ header. Link to this property preload: Optional\[bool] Enable automatic preload of the HSTS configuration. Link to this property
Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20security_headers%20%3E%20(schema)>)
class SecurityLevel: … id: Optional\[Literal\["security\_level"]] Control options for the **Security Level** feature from the **Security** app. Link to this property
value: Optional\[Literal\["off", "essentially\_off", "low", 3 more]] One of the following: "off" Link to this property "essentially\_off" Link to this property "low" Link to this property "medium" Link to this property "high" Link to this property "under\_attack" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20security_level%20%3E%20(schema)>)
class ServerSideExcludes: … If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won’t see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won’t see the SSE tags in your HTML source when it’s served through Cloudflare. SSE will still function in this case, as Cloudflare’s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor’s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036). id: Literal\["server\_side\_exclude"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20server_side_excludes%20%3E%20(schema)>)
class SortQueryStringForCache: … id: Optional\[Literal\["sort\_query\_string\_for\_cache"]] Turn on or off the reordering of query strings. When query strings have the same structure, caching improves. Link to this property
value: Optional\[Literal\["on", "off"]] The status of Query String Sort One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20sort_query_string_for_cache%20%3E%20(schema)>)
class SSL: … id: Optional\[Literal\["ssl"]] Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app. Link to this property
value: Optional\[Literal\["off", "flexible", "full", 2 more]] The encryption mode that Cloudflare uses to connect to your origin server. One of the following: "off" Link to this property "flexible" Link to this property "full" Link to this property "strict" Link to this property "origin\_pull" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20ssl%20%3E%20(schema)>)
class SSLRecommender: … Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. id: Optional\[Literal\["ssl\_recommender"]] Enrollment value for SSL/TLS Recommender. Link to this property enabled: Optional\[bool] ssl-recommender enrollment setting. Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20ssl_recommender%20%3E%20(schema)>)
class TLS1\_3: … Enables Crypto TLS 1.3 feature for a zone. id: Literal\["tls\_1\_3"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "zrt"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "zrt" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20tls_1_3%20%3E%20(schema)>)
class TLSClientAuth: … TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). id: Literal\["tls\_client\_auth"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20tls_client_auth%20%3E%20(schema)>)
class TrueClientIPHeader: … id: Optional\[Literal\["true\_client\_ip\_header"]] Turn on or off the True-Client-IP Header feature of the Cloudflare Network app. Link to this property
value: Optional\[Literal\["on", "off"]] The status of True Client IP Header. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20true_client_ip_header%20%3E%20(schema)>)
class WAF: … id: Optional\[Literal\["waf"]] Turn on or off WAF managed rules (previous version, deprecated). You cannot enable or disable individual WAF managed rules via Page Rules. Link to this property
value: Optional\[Literal\["on", "off"]] The status of WAF managed rules (previous version). One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20waf%20%3E%20(schema)>)
class WebP: … When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. id: Literal\["webp"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20webp%20%3E%20(schema)>)
class Websocket: … WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to Can I use Cloudflare with Websockets. id: Literal\["websockets"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20websocket%20%3E%20(schema)>)
class ZeroRTT: … 0-RTT session resumption enabled for this zone. id: Literal\["0rtt"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20zero_rtt%20%3E%20(schema)>)
SettingGetResponse 0-RTT session resumption enabled for this zone. One of the following:
class ZeroRTT: … 0-RTT session resumption enabled for this zone. id: Literal\["0rtt"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class AdvancedDDoS: … Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is ‘on’ in the case of Business and Enterprise zones. id: Literal\["advanced\_ddos"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesCacheRulesAegis: … Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. id: Literal\["aegis"] ID of the zone setting. Link to this property modified\_on: Optional\[datetime] Last time this setting was modified. formatdate-time Link to this property
value: Optional\[ZonesCacheRulesAegisValue] Value of the zone setting. enabled: Optional\[bool] Whether the feature is enabled or not. Link to this property pool\_id: Optional\[str] Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. Link to this property
Link to this property
Link to this property
class AlwaysOnline: … When enabled, Cloudflare serves limited copies of web pages available from the Internet Archive’s Wayback Machine if your server is offline. Refer to Always Online for more information. id: Literal\["always\_online"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesAlwaysUseHTTPS2: … Reply to all requests for URLs that use “http” with a 301 redirect to the equivalent “https” URL. If you only want to redirect for a subset of requests, consider creating an “Always use HTTPS” page rule. id: Literal\["always\_use\_https"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesAutomaticHTTPSRewrites2: … Enable the Automatic HTTPS Rewrites feature for this zone. id: Literal\["automatic\_https\_rewrites"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class Brotli: … When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. id: Literal\["brotli"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesBrowserCacheTTL2: … Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors’ computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). id: Literal\["browser\_cache\_ttl"] ID of the zone setting. Link to this property value: int Current value of the zone setting. maximum31536000 minimum0 Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesBrowserCheck2: … Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). id: Literal\["browser\_check"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesCacheLevel2: … Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). id: Literal\["cache\_level"] ID of the zone setting. Link to this property
value: Literal\["aggressive", "basic", "simplified"] Current value of the zone setting. One of the following: "aggressive" Link to this property "basic" Link to this property "simplified" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ChallengeTTL: … Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). id: Literal\["challenge\_ttl"] ID of the zone setting. Link to this property
value: Literal\[300, 900, 1800, 11 more] Current value of the zone setting. One of the following: 300 Link to this property 900 Link to this property 1800 Link to this property 2700 Link to this property 3600 Link to this property 7200 Link to this property 10800 Link to this property 14400 Link to this property 28800 Link to this property 57600 Link to this property 86400 Link to this property 604800 Link to this property 2592000 Link to this property 31536000 Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesChinaNetworkEnabled: … Determines whether or not the china network is enabled. id: Literal\["china\_network\_enabled"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesContentConverter: … When enabled and the client sends an Accept header requesting text/markdown, Cloudflare will convert HTML responses to Markdown format using the toMarkdown() service. Refer to the developer documentation for more information. id: Literal\["content\_converter"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class Ciphers: … An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. id: Literal\["ciphers"] ID of the zone setting. Link to this property value: List\[str] Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesCNAMEFlattening: … Whether or not cname flattening is on. id: Literal\["cname\_flattening"] How to flatten the cname destination. Link to this property
Deprecatedvalue: Literal\["flatten\_at\_root", "flatten\_all"] This zone setting is deprecated; please use the DNS Settings route instead. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21 Current value of the zone setting. One of the following: "flatten\_at\_root" Link to this property "flatten\_all" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class DevelopmentMode: … Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare’s accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. id: Literal\["development\_mode"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property time\_remaining: Optional\[float] Value of the zone setting. Notes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false. Link to this property
Link to this property
class EarlyHints: … When enabled, Cloudflare will attempt to speed up overall page loads by serving 103 responses with Link headers from the final response. Refer to Early Hints for more information. id: Literal\["early\_hints"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesEdgeCacheTTL2: … Time (in seconds) that a resource will be ensured to remain on Cloudflare’s cache servers. id: Literal\["edge\_cache\_ttl"] ID of the zone setting. Link to this property
value: Literal\[30, 60, 300, 18 more] Current value of the zone setting. One of the following: 30 Link to this property 60 Link to this property 300 Link to this property 1200 Link to this property 1800 Link to this property 3600 Link to this property 7200 Link to this property 10800 Link to this property 14400 Link to this property 18000 Link to this property 28800 Link to this property 43200 Link to this property 57600 Link to this property 72000 Link to this property 86400 Link to this property 172800 Link to this property 259200 Link to this property 345600 Link to this property 432000 Link to this property 518400 Link to this property 604800 Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesEmailObfuscation2: … Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). id: Literal\["email\_obfuscation"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class H2Prioritization: … HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. id: Literal\["h2\_prioritization"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "custom"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "custom" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class HotlinkProtection: … When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it’s not another site requesting them. People will still be able to download and view images from your page, but other sites won’t be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). id: Literal\["hotlink\_protection"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class HTTP2: … HTTP2 enabled for this zone. id: Literal\["http2"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class HTTP3: … HTTP3 enabled for this zone. id: Literal\["http3"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ImageResizing: … Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare’s network. Refer to the Image Transformations documentation for more information. id: Literal\["image\_resizing"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "open"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "open" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesIPGeolocation2: … Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). id: Literal\["ip\_geolocation"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class IPV6: … Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). id: Literal\["ipv6"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesMaxUpload: … Maximum size of an allowable upload. id: Literal\["max\_upload"] identifier of the zone setting. Link to this property
value: Literal\[100, 125, 150, 23 more] Current value of the zone setting. One of the following: 100 Link to this property 125 Link to this property 150 Link to this property 175 Link to this property 200 Link to this property 225 Link to this property 250 Link to this property 275 Link to this property 300 Link to this property 325 Link to this property 350 Link to this property 375 Link to this property 400 Link to this property 425 Link to this property 450 Link to this property 475 Link to this property 500 Link to this property 1000 Link to this property 1500 Link to this property 2000 Link to this property 2500 Link to this property 3000 Link to this property 3500 Link to this property 4000 Link to this property 4500 Link to this property 5000 Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class MinTLSVersion: … Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. id: Literal\["min\_tls\_version"] ID of the zone setting. Link to this property
value: Literal\["1.0", "1.1", "1.2", "1.3"] Current value of the zone setting. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesMirage2: … Automatically optimize image loading for website visitors on mobile devices. Refer to our blog post for more information. id: Literal\["mirage"] ID of the zone setting. Link to this property
Deprecatedvalue: Literal\["on", "off"] Mirage is being deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/ Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class NEL: … Enable Network Error Logging reporting on your zone. (Beta) id: Literal\["nel"] Zone setting identifier. Link to this property
value: Value Current value of the zone setting. enabled: Optional\[bool] Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesOpportunisticEncryption2: … Enables the Opportunistic Encryption feature for a zone. id: Literal\["opportunistic\_encryption"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class OpportunisticOnion: … Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. id: Literal\["opportunistic\_onion"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class OrangeToOrange: … Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. id: Literal\["orange\_to\_orange"] ID of the zone setting. Link to this property
Deprecatedvalue: Literal\["on", "off"] This setting is deprecated. Orange to Orange (O2O) is applied automatically for eligible zones and no longer requires configuration; this setting only controlled the legacy O2O v1 (Managed CNAME) path. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/ Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesOriginErrorPagePassThru2: … Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. id: Literal\["origin\_error\_page\_pass\_thru"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesCacheRulesOriginH2MaxStreams: … Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is 100 for all plan types except Enterprise where it is 1. 1 means that H2 multiplexing is disabled. id: Literal\["origin\_h2\_max\_streams"] Value of the zone setting. Link to this property modified\_on: Optional\[datetime] Last time this setting was modified. formatdate-time Link to this property value: Optional\[int] Value of the Origin H2 Max Streams Setting. maximum1000 minimum1 Link to this property
Link to this property
class ZonesCacheRulesOriginMaxHTTPVersion: … Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to Enable HTTP/2 to Origin, for more information.). The default value is “2” for all plan types except Enterprise where it is “1”. id: Literal\["origin\_max\_http\_version"] Value of the zone setting. Link to this property modified\_on: Optional\[datetime] Last time this setting was modified. formatdate-time Link to this property
value: Optional\[Literal\["2", "1"]] Value of the Origin Max HTTP Version Setting. One of the following: "2" Link to this property "1" Link to this property
Link to this property
Link to this property
class ZonesPolish2: … Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites. id: Literal\["polish"] ID of the zone setting. Link to this property
value: Literal\["off", "lossless", "lossy"] Current value of the zone setting. One of the following: "off" Link to this property "lossless" Link to this property "lossy" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class PrefetchPreload: … Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. id: Literal\["prefetch\_preload"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesPreRender: … When enabled, Cloudflare serves pre-rendered HTML to eligible search and AI crawlers instead of the origin’s unrendered response. id: Literal\["pre\_render"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesPrivacyPass: … Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass). id: Literal\["privacy\_pass"] ID of the zone setting. Link to this property
Deprecatedvalue: Literal\["on", "off"] Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31) Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ProxyReadTimeout: … Maximum time between two read operations from origin. id: Literal\["proxy\_read\_timeout"] ID of the zone setting. Link to this property value: float Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class PseudoIPV4: … The value set for the Pseudo IPv4 setting. id: Literal\["pseudo\_ipv4"] Value of the Pseudo IPv4 setting. Link to this property
value: Literal\["off", "add\_header", "overwrite\_header"] Current value of the zone setting. One of the following: "off" Link to this property "add\_header" Link to this property "overwrite\_header" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesRedirectsForAITraining: … When enabled, Cloudflare will redirect verified AI training crawlers to canonical URLs found in the HTML response, ensuring AI models train on authoritative content. id: Literal\["redirects\_for\_ai\_training"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesReplaceInsecureJS: … Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io. id: Literal\["replace\_insecure\_js"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesResponseBuffering2: … Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. id: Literal\["response\_buffering"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesRocketLoader2: … Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site’s Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page’s rendering time sometimes measured as Time to First Paint (TTFP), and also the window.onload time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to Understanding Rocket Loader for more information. id: Literal\["rocket\_loader"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSchemasAutomaticPlatformOptimization: … Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare’s edge network and caches third-party fonts. id: Literal\["automatic\_platform\_optimization"] ID of the zone setting. Link to this property value: AutomaticPlatformOptimization Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSearchForAgents: … When enabled, Cloudflare provisions an AI Search instance for the zone and exposes a /.well-known/ai-search endpoint that AI agents can query. Markdown responses also receive an agent: YAML capability block advertising the search endpoint. id: Literal\["search\_for\_agents"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class SecurityHeaders: … Cloudflare security header for a zone. id: Literal\["security\_header"] ID of the zone’s security header. Link to this property
value: Value Current value of the zone setting.
strict\_transport\_security: Optional\[ValueStrictTransportSecurity] Strict Transport Security. enabled: Optional\[bool] Whether or not strict transport security is enabled. Link to this property include\_subdomains: Optional\[bool] Include all subdomains for strict transport security. Link to this property max\_age: Optional\[float] Max age in seconds of the strict transport security. Link to this property nosniff: Optional\[bool] Whether or not to include ‘X-Content-Type-Options: nosniff’ header. Link to this property preload: Optional\[bool] Enable automatic preload of the HSTS configuration. Link to this property
Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSecurityLevel2: … Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). id: Literal\["security\_level"] ID of the zone setting. Link to this property
value: Literal\["off", "essentially\_off", "low", 3 more] Current value of the zone setting. One of the following: "off" Link to this property "essentially\_off" Link to this property "low" Link to this property "medium" Link to this property "high" Link to this property "under\_attack" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ServerSideExcludes: … If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won’t see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won’t see the SSE tags in your HTML source when it’s served through Cloudflare. SSE will still function in this case, as Cloudflare’s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor’s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036). id: Literal\["server\_side\_exclude"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSha1Support: … Allow SHA1 support. id: Literal\["sha1\_support"] Zone setting identifier. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSortQueryStringForCache2: … Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. id: Literal\["sort\_query\_string\_for\_cache"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSSL2: … SSL encrypts your visitor’s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare — visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don’t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare — visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You’ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare — visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You’ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416). id: Literal\["ssl"] ID of the zone setting. Link to this property
value: Literal\["off", "flexible", "full", "strict"] Current value of the zone setting. One of the following: "off" Link to this property "flexible" Link to this property "full" Link to this property "strict" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class SSLRecommender: … Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. id: Optional\[Literal\["ssl\_recommender"]] Enrollment value for SSL/TLS Recommender. Link to this property enabled: Optional\[bool] ssl-recommender enrollment setting. Link to this property
Link to this property
class ZonesTLS1\_2Only: … Only allows TLS1.2. id: Literal\["tls\_1\_2\_only"] Zone setting identifier. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class TLS1\_3: … Enables Crypto TLS 1.3 feature for a zone. id: Literal\["tls\_1\_3"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "zrt"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "zrt" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class TLSClientAuth: … TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). id: Literal\["tls\_client\_auth"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesTransformations: … Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare’s network. Refer to the Image Transformations and Video Transformations documentation for more information. id: Literal\["transformations"] ID of the zone setting. Shared between Image Transformations and Video Transformations. Link to this property
value: Literal\["on", "off", "open"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "open" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesTransformationsAllowedOrigins: … Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare’s network. Refer to the Image Transformations and Video Transformations documentation for more information. id: Literal\["transformations\_allowed\_origins"] ID of the zone setting. Shared between Image Transformations and Video Transformations. Link to this property value: str Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesTrueClientIPHeader2: … Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. id: Literal\["true\_client\_ip\_header"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesWAF2: … The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will ‘challenge’ the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare’s WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). id: Literal\["waf"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesWebmcpEnabled: … When enabled, Cloudflare injects the WebMCP bridge (bridge.js) into HTML responses for this zone, exposing DOM and Content Credentials tools to an in-browser AI agent via navigator.modelContext. No origin-side code changes are required. This setting is currently in beta and its behavior may change. id: Literal\["webmcp\_enabled"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesWebmcpMcpURL: … Optional per-zone path of the site’s own MCP server, used by the WebMCP mcp-server-client tool pack to list and call the site’s MCP tools from the browser. The path is resolved against the page’s origin, so it applies to every hostname in the zone. Only takes effect when webmcp\_enabled is on and the mcp-server-client pack is active. Leave empty to use /mcp. This setting is currently in beta and its behavior may change. id: Literal\["webmcp\_mcp\_url"] ID of the zone setting. Link to this property value: str Current value of the zone setting. maxLength2048 Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesWebmcpPacks: … Optional per-zone override of which bundled WebMCP tool packs the injected bridge.js activates. Only takes effect when webmcp\_enabled is on. Leave empty to use the bridge’s default pack set. Unknown pack names are ignored by the bridge. This setting is currently in beta and its behavior may change. id: Literal\["webmcp\_packs"] ID of the zone setting. Link to this property value: str Current value of the zone setting. maxLength256 Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class WebP: … When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. id: Literal\["webp"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class Websocket: … WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to Can I use Cloudflare with Websockets. id: Literal\["websockets"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)>)
SettingEditResponse 0-RTT session resumption enabled for this zone. One of the following:
class ZeroRTT: … 0-RTT session resumption enabled for this zone. id: Literal\["0rtt"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class AdvancedDDoS: … Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is ‘on’ in the case of Business and Enterprise zones. id: Literal\["advanced\_ddos"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesCacheRulesAegis: … Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. id: Literal\["aegis"] ID of the zone setting. Link to this property modified\_on: Optional\[datetime] Last time this setting was modified. formatdate-time Link to this property
value: Optional\[ZonesCacheRulesAegisValue] Value of the zone setting. enabled: Optional\[bool] Whether the feature is enabled or not. Link to this property pool\_id: Optional\[str] Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. Link to this property
Link to this property
Link to this property
class AlwaysOnline: … When enabled, Cloudflare serves limited copies of web pages available from the Internet Archive’s Wayback Machine if your server is offline. Refer to Always Online for more information. id: Literal\["always\_online"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesAlwaysUseHTTPS2: … Reply to all requests for URLs that use “http” with a 301 redirect to the equivalent “https” URL. If you only want to redirect for a subset of requests, consider creating an “Always use HTTPS” page rule. id: Literal\["always\_use\_https"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesAutomaticHTTPSRewrites2: … Enable the Automatic HTTPS Rewrites feature for this zone. id: Literal\["automatic\_https\_rewrites"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class Brotli: … When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. id: Literal\["brotli"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesBrowserCacheTTL2: … Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors’ computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). id: Literal\["browser\_cache\_ttl"] ID of the zone setting. Link to this property value: int Current value of the zone setting. maximum31536000 minimum0 Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesBrowserCheck2: … Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). id: Literal\["browser\_check"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesCacheLevel2: … Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). id: Literal\["cache\_level"] ID of the zone setting. Link to this property
value: Literal\["aggressive", "basic", "simplified"] Current value of the zone setting. One of the following: "aggressive" Link to this property "basic" Link to this property "simplified" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ChallengeTTL: … Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). id: Literal\["challenge\_ttl"] ID of the zone setting. Link to this property
value: Literal\[300, 900, 1800, 11 more] Current value of the zone setting. One of the following: 300 Link to this property 900 Link to this property 1800 Link to this property 2700 Link to this property 3600 Link to this property 7200 Link to this property 10800 Link to this property 14400 Link to this property 28800 Link to this property 57600 Link to this property 86400 Link to this property 604800 Link to this property 2592000 Link to this property 31536000 Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesChinaNetworkEnabled: … Determines whether or not the china network is enabled. id: Literal\["china\_network\_enabled"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesContentConverter: … When enabled and the client sends an Accept header requesting text/markdown, Cloudflare will convert HTML responses to Markdown format using the toMarkdown() service. Refer to the developer documentation for more information. id: Literal\["content\_converter"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class Ciphers: … An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. id: Literal\["ciphers"] ID of the zone setting. Link to this property value: List\[str] Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesCNAMEFlattening: … Whether or not cname flattening is on. id: Literal\["cname\_flattening"] How to flatten the cname destination. Link to this property
Deprecatedvalue: Literal\["flatten\_at\_root", "flatten\_all"] This zone setting is deprecated; please use the DNS Settings route instead. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21 Current value of the zone setting. One of the following: "flatten\_at\_root" Link to this property "flatten\_all" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class DevelopmentMode: … Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare’s accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. id: Literal\["development\_mode"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property time\_remaining: Optional\[float] Value of the zone setting. Notes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false. Link to this property
Link to this property
class EarlyHints: … When enabled, Cloudflare will attempt to speed up overall page loads by serving 103 responses with Link headers from the final response. Refer to Early Hints for more information. id: Literal\["early\_hints"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesEdgeCacheTTL2: … Time (in seconds) that a resource will be ensured to remain on Cloudflare’s cache servers. id: Literal\["edge\_cache\_ttl"] ID of the zone setting. Link to this property
value: Literal\[30, 60, 300, 18 more] Current value of the zone setting. One of the following: 30 Link to this property 60 Link to this property 300 Link to this property 1200 Link to this property 1800 Link to this property 3600 Link to this property 7200 Link to this property 10800 Link to this property 14400 Link to this property 18000 Link to this property 28800 Link to this property 43200 Link to this property 57600 Link to this property 72000 Link to this property 86400 Link to this property 172800 Link to this property 259200 Link to this property 345600 Link to this property 432000 Link to this property 518400 Link to this property 604800 Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesEmailObfuscation2: … Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). id: Literal\["email\_obfuscation"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class H2Prioritization: … HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. id: Literal\["h2\_prioritization"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "custom"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "custom" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class HotlinkProtection: … When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it’s not another site requesting them. People will still be able to download and view images from your page, but other sites won’t be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). id: Literal\["hotlink\_protection"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class HTTP2: … HTTP2 enabled for this zone. id: Literal\["http2"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class HTTP3: … HTTP3 enabled for this zone. id: Literal\["http3"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ImageResizing: … Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare’s network. Refer to the Image Transformations documentation for more information. id: Literal\["image\_resizing"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "open"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "open" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesIPGeolocation2: … Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). id: Literal\["ip\_geolocation"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class IPV6: … Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). id: Literal\["ipv6"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesMaxUpload: … Maximum size of an allowable upload. id: Literal\["max\_upload"] identifier of the zone setting. Link to this property
value: Literal\[100, 125, 150, 23 more] Current value of the zone setting. One of the following: 100 Link to this property 125 Link to this property 150 Link to this property 175 Link to this property 200 Link to this property 225 Link to this property 250 Link to this property 275 Link to this property 300 Link to this property 325 Link to this property 350 Link to this property 375 Link to this property 400 Link to this property 425 Link to this property 450 Link to this property 475 Link to this property 500 Link to this property 1000 Link to this property 1500 Link to this property 2000 Link to this property 2500 Link to this property 3000 Link to this property 3500 Link to this property 4000 Link to this property 4500 Link to this property 5000 Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class MinTLSVersion: … Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. id: Literal\["min\_tls\_version"] ID of the zone setting. Link to this property
value: Literal\["1.0", "1.1", "1.2", "1.3"] Current value of the zone setting. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesMirage2: … Automatically optimize image loading for website visitors on mobile devices. Refer to our blog post for more information. id: Literal\["mirage"] ID of the zone setting. Link to this property
Deprecatedvalue: Literal\["on", "off"] Mirage is being deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/ Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class NEL: … Enable Network Error Logging reporting on your zone. (Beta) id: Literal\["nel"] Zone setting identifier. Link to this property
value: Value Current value of the zone setting. enabled: Optional\[bool] Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesOpportunisticEncryption2: … Enables the Opportunistic Encryption feature for a zone. id: Literal\["opportunistic\_encryption"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class OpportunisticOnion: … Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. id: Literal\["opportunistic\_onion"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class OrangeToOrange: … Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. id: Literal\["orange\_to\_orange"] ID of the zone setting. Link to this property
Deprecatedvalue: Literal\["on", "off"] This setting is deprecated. Orange to Orange (O2O) is applied automatically for eligible zones and no longer requires configuration; this setting only controlled the legacy O2O v1 (Managed CNAME) path. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/ Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesOriginErrorPagePassThru2: … Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. id: Literal\["origin\_error\_page\_pass\_thru"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesCacheRulesOriginH2MaxStreams: … Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is 100 for all plan types except Enterprise where it is 1. 1 means that H2 multiplexing is disabled. id: Literal\["origin\_h2\_max\_streams"] Value of the zone setting. Link to this property modified\_on: Optional\[datetime] Last time this setting was modified. formatdate-time Link to this property value: Optional\[int] Value of the Origin H2 Max Streams Setting. maximum1000 minimum1 Link to this property
Link to this property
class ZonesCacheRulesOriginMaxHTTPVersion: … Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to Enable HTTP/2 to Origin, for more information.). The default value is “2” for all plan types except Enterprise where it is “1”. id: Literal\["origin\_max\_http\_version"] Value of the zone setting. Link to this property modified\_on: Optional\[datetime] Last time this setting was modified. formatdate-time Link to this property
value: Optional\[Literal\["2", "1"]] Value of the Origin Max HTTP Version Setting. One of the following: "2" Link to this property "1" Link to this property
Link to this property
Link to this property
class ZonesPolish2: … Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites. id: Literal\["polish"] ID of the zone setting. Link to this property
value: Literal\["off", "lossless", "lossy"] Current value of the zone setting. One of the following: "off" Link to this property "lossless" Link to this property "lossy" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class PrefetchPreload: … Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. id: Literal\["prefetch\_preload"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesPreRender: … When enabled, Cloudflare serves pre-rendered HTML to eligible search and AI crawlers instead of the origin’s unrendered response. id: Literal\["pre\_render"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesPrivacyPass: … Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass). id: Literal\["privacy\_pass"] ID of the zone setting. Link to this property
Deprecatedvalue: Literal\["on", "off"] Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31) Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ProxyReadTimeout: … Maximum time between two read operations from origin. id: Literal\["proxy\_read\_timeout"] ID of the zone setting. Link to this property value: float Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class PseudoIPV4: … The value set for the Pseudo IPv4 setting. id: Literal\["pseudo\_ipv4"] Value of the Pseudo IPv4 setting. Link to this property
value: Literal\["off", "add\_header", "overwrite\_header"] Current value of the zone setting. One of the following: "off" Link to this property "add\_header" Link to this property "overwrite\_header" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesRedirectsForAITraining: … When enabled, Cloudflare will redirect verified AI training crawlers to canonical URLs found in the HTML response, ensuring AI models train on authoritative content. id: Literal\["redirects\_for\_ai\_training"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesReplaceInsecureJS: … Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io. id: Literal\["replace\_insecure\_js"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesResponseBuffering2: … Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. id: Literal\["response\_buffering"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesRocketLoader2: … Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site’s Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page’s rendering time sometimes measured as Time to First Paint (TTFP), and also the window.onload time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to Understanding Rocket Loader for more information. id: Literal\["rocket\_loader"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSchemasAutomaticPlatformOptimization: … Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare’s edge network and caches third-party fonts. id: Literal\["automatic\_platform\_optimization"] ID of the zone setting. Link to this property value: AutomaticPlatformOptimization Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSearchForAgents: … When enabled, Cloudflare provisions an AI Search instance for the zone and exposes a /.well-known/ai-search endpoint that AI agents can query. Markdown responses also receive an agent: YAML capability block advertising the search endpoint. id: Literal\["search\_for\_agents"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class SecurityHeaders: … Cloudflare security header for a zone. id: Literal\["security\_header"] ID of the zone’s security header. Link to this property
value: Value Current value of the zone setting.
strict\_transport\_security: Optional\[ValueStrictTransportSecurity] Strict Transport Security. enabled: Optional\[bool] Whether or not strict transport security is enabled. Link to this property include\_subdomains: Optional\[bool] Include all subdomains for strict transport security. Link to this property max\_age: Optional\[float] Max age in seconds of the strict transport security. Link to this property nosniff: Optional\[bool] Whether or not to include ‘X-Content-Type-Options: nosniff’ header. Link to this property preload: Optional\[bool] Enable automatic preload of the HSTS configuration. Link to this property
Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSecurityLevel2: … Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). id: Literal\["security\_level"] ID of the zone setting. Link to this property
value: Literal\["off", "essentially\_off", "low", 3 more] Current value of the zone setting. One of the following: "off" Link to this property "essentially\_off" Link to this property "low" Link to this property "medium" Link to this property "high" Link to this property "under\_attack" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ServerSideExcludes: … If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won’t see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won’t see the SSE tags in your HTML source when it’s served through Cloudflare. SSE will still function in this case, as Cloudflare’s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor’s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036). id: Literal\["server\_side\_exclude"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSha1Support: … Allow SHA1 support. id: Literal\["sha1\_support"] Zone setting identifier. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSortQueryStringForCache2: … Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. id: Literal\["sort\_query\_string\_for\_cache"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesSSL2: … SSL encrypts your visitor’s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare — visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don’t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare — visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You’ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare — visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You’ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416). id: Literal\["ssl"] ID of the zone setting. Link to this property
value: Literal\["off", "flexible", "full", "strict"] Current value of the zone setting. One of the following: "off" Link to this property "flexible" Link to this property "full" Link to this property "strict" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class SSLRecommender: … Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. id: Optional\[Literal\["ssl\_recommender"]] Enrollment value for SSL/TLS Recommender. Link to this property enabled: Optional\[bool] ssl-recommender enrollment setting. Link to this property
Link to this property
class ZonesTLS1\_2Only: … Only allows TLS1.2. id: Literal\["tls\_1\_2\_only"] Zone setting identifier. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class TLS1\_3: … Enables Crypto TLS 1.3 feature for a zone. id: Literal\["tls\_1\_3"] ID of the zone setting. Link to this property
value: Literal\["on", "off", "zrt"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "zrt" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class TLSClientAuth: … TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). id: Literal\["tls\_client\_auth"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesTransformations: … Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare’s network. Refer to the Image Transformations and Video Transformations documentation for more information. id: Literal\["transformations"] ID of the zone setting. Shared between Image Transformations and Video Transformations. Link to this property
value: Literal\["on", "off", "open"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property "open" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesTransformationsAllowedOrigins: … Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare’s network. Refer to the Image Transformations and Video Transformations documentation for more information. id: Literal\["transformations\_allowed\_origins"] ID of the zone setting. Shared between Image Transformations and Video Transformations. Link to this property value: str Current value of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesTrueClientIPHeader2: … Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. id: Literal\["true\_client\_ip\_header"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesWAF2: … The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will ‘challenge’ the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare’s WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). id: Literal\["waf"] ID of the zone setting. Link to this property
value: Literal\["on", "off"] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesWebmcpEnabled: … When enabled, Cloudflare injects the WebMCP bridge (bridge.js) into HTML responses for this zone, exposing DOM and Content Credentials tools to an in-browser AI agent via navigator.modelContext. No origin-side code changes are required. This setting is currently in beta and its behavior may change. id: Literal\["webmcp\_enabled"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesWebmcpMcpURL: … Optional per-zone path of the site’s own MCP server, used by the WebMCP mcp-server-client tool pack to list and call the site’s MCP tools from the browser. The path is resolved against the page’s origin, so it applies to every hostname in the zone. Only takes effect when webmcp\_enabled is on and the mcp-server-client pack is active. Leave empty to use /mcp. This setting is currently in beta and its behavior may change. id: Literal\["webmcp\_mcp\_url"] ID of the zone setting. Link to this property value: str Current value of the zone setting. maxLength2048 Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class ZonesWebmcpPacks: … Optional per-zone override of which bundled WebMCP tool packs the injected bridge.js activates. Only takes effect when webmcp\_enabled is on. Leave empty to use the bridge’s default pack set. Unknown pack names are ignored by the bridge. This setting is currently in beta and its behavior may change. id: Literal\["webmcp\_packs"] ID of the zone setting. Link to this property value: str Current value of the zone setting. maxLength256 Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class WebP: … When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. id: Literal\["webp"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
class Websocket: … WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to Can I use Cloudflare with Websockets. id: Literal\["websockets"] ID of the zone setting. Link to this property
value: Literal\["off", "on"] Current value of the zone setting. One of the following: "off" Link to this property "on" Link to this property
Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(model)%20setting_edit_response%20%3E%20(schema)>) #### ZonesTransformations Allowed Origins ##### [Get Image Transformations Allowed Origins setting](https://developers.cloudflare.com/api/python/resources/zones/subresources/transformations_allowed_origins/methods/get) zones.transformations\_allowed\_origins.get(TransformationsAllowedOriginGetParams\*\*kwargs) -> [TransformationsAllowedOrigins]() GET/zones/{zone\_id}/settings/transformations\_allowed\_origins ##### [Change Image Transformations Allowed Origins setting](https://developers.cloudflare.com/api/python/resources/zones/subresources/transformations_allowed_origins/methods/edit) zones.transformations\_allowed\_origins.edit(TransformationsAllowedOriginEditParams\*\*kwargs) -> [TransformationsAllowedOrigins]() PATCH/zones/{zone\_id}/settings/transformations\_allowed\_origins ##### ModelsExpand Collapse
class TransformationsAllowedOrigins: … Controls which origins are allowed to request image and video transformations. id: Optional\[Literal\["image\_resizing\_allowed\_origins"]] ID of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
value: Optional\[Literal\["on", "off"]] Comma-separated list of allowed origin domains for image and video transformations. Use ”\*” to allow all origins (default). One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.transformations_allowed_origins%20%3E%20(model)%20transformations_allowed_origins%20%3E%20(schema)>) #### ZonesTransformations C2pa ##### [Get Image Transformations C2PA setting](https://developers.cloudflare.com/api/python/resources/zones/subresources/transformations_c2pa/methods/get) zones.transformations\_c2pa.get(TransformationsC2paGetParams\*\*kwargs) -> [TransformationsC2pa]() GET/zones/{zone\_id}/settings/transformations\_c2pa ##### [Change Image Transformations C2PA setting](https://developers.cloudflare.com/api/python/resources/zones/subresources/transformations_c2pa/methods/edit) zones.transformations\_c2pa.edit(TransformationsC2paEditParams\*\*kwargs) -> [TransformationsC2pa]() PATCH/zones/{zone\_id}/settings/transformations\_c2pa ##### ModelsExpand Collapse
class TransformationsC2pa: … Controls C2PA signing for images processed through Cloudflare Image Transformations. id: Optional\[Literal\["image\_resizing\_c2pa"]] ID of the zone setting. Link to this property
editable: Optional\[Literal\[true, false]] Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: true Link to this property false Link to this property
Link to this property modified\_on: Optional\[datetime] last time this setting was modified. formatdate-time Link to this property
value: Optional\[Literal\["on", "off"]] Current value of the zone setting. One of the following: "on" Link to this property "off" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.transformations_c2pa%20%3E%20(model)%20transformations_c2pa%20%3E%20(schema)>) #### ZonesNEL ##### [Get NEL setting](https://developers.cloudflare.com/api/python/resources/zones/subresources/nel/methods/get) zones.nel.get(NELGetParams\*\*kwargs) -> [Setting]() GET/zones/{zone\_id}/settings/nel ##### [Edit NEL setting](https://developers.cloudflare.com/api/python/resources/zones/subresources/nel/methods/edit) zones.nel.edit(NELEditParams\*\*kwargs) -> [Setting]() PATCH/zones/{zone\_id}/settings/nel ##### ModelsExpand Collapse
class Setting: … A zone-scoped NEL configuration setting. id: Literal\["nel"] Zone setting identifier. Link to this property editable: bool Whether the setting is editable. This is false when the zone’s plan does not include NEL or the NEL product feature is not enabled. Link to this property modified\_on: datetime When the setting was last modified. A zero value (0001-01-01T00:00:00Z) indicates the setting has never been explicitly set and is using the default value. formatdate-time Link to this property
value: Value The NEL configuration value. enabled: bool Whether Network Error Logging is enabled for the zone. When enabled, browsers report network errors to Cloudflare’s NEL endpoint. Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.nel%20%3E%20(model)%20setting%20%3E%20(schema)>) #### ZonesEnvironments ##### [List zone environments](https://developers.cloudflare.com/api/python/resources/zones/subresources/environments/methods/list) zones.environments.list(EnvironmentListParams\*\*kwargs) -> [EnvironmentListResponse]() GET/zones/{zone\_id}/environments ##### [Create zone environments](https://developers.cloudflare.com/api/python/resources/zones/subresources/environments/methods/create) zones.environments.create(EnvironmentCreateParams\*\*kwargs) -> [EnvironmentCreateResponse]() POST/zones/{zone\_id}/environments ##### [Upsert zone environments](https://developers.cloudflare.com/api/python/resources/zones/subresources/environments/methods/update) zones.environments.update(EnvironmentUpdateParams\*\*kwargs) -> [EnvironmentUpdateResponse]() PUT/zones/{zone\_id}/environments ##### [Partially update zone environments](https://developers.cloudflare.com/api/python/resources/zones/subresources/environments/methods/edit) zones.environments.edit(EnvironmentEditParams\*\*kwargs) -> [EnvironmentEditResponse]() PATCH/zones/{zone\_id}/environments ##### [Delete zone environment](https://developers.cloudflare.com/api/python/resources/zones/subresources/environments/methods/delete) zones.environments.delete(strenvironment\_id, EnvironmentDeleteParams\*\*kwargs) -> [EnvironmentDeleteResponse]() DELETE/zones/{zone\_id}/environments/{environment\_id} ##### [Roll back zone environment](https://developers.cloudflare.com/api/python/resources/zones/subresources/environments/methods/rollback) zones.environments.rollback(strenvironment\_id, EnvironmentRollbackParams\*\*kwargs) -> [EnvironmentRollbackResponse]() POST/zones/{zone\_id}/environments/{environment\_id}/rollback ##### ModelsExpand Collapse
class EnvironmentListResponse: …
environments: List\[Environment] expression: str Link to this property locked\_on\_deployment: Optional\[bool] Link to this property name: str Link to this property position: ListCursor Link to this property ref: str Link to this property version: Optional\[int] formatint64 Link to this property http\_application\_id: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.environments%20%3E%20(model)%20environment_list_response%20%3E%20(schema)>)
class EnvironmentCreateResponse: …
environments: List\[Environment] expression: str Link to this property locked\_on\_deployment: Optional\[bool] Link to this property name: str Link to this property position: ListCursor Link to this property ref: str Link to this property version: Optional\[int] formatint64 Link to this property http\_application\_id: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.environments%20%3E%20(model)%20environment_create_response%20%3E%20(schema)>)
class EnvironmentUpdateResponse: …
environments: List\[Environment] expression: str Link to this property locked\_on\_deployment: Optional\[bool] Link to this property name: str Link to this property position: ListCursor Link to this property ref: str Link to this property version: Optional\[int] formatint64 Link to this property http\_application\_id: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.environments%20%3E%20(model)%20environment_update_response%20%3E%20(schema)>)
class EnvironmentEditResponse: …
environments: List\[Environment] expression: str Link to this property locked\_on\_deployment: Optional\[bool] Link to this property name: str Link to this property position: ListCursor Link to this property ref: str Link to this property version: Optional\[int] formatint64 Link to this property http\_application\_id: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.environments%20%3E%20(model)%20environment_edit_response%20%3E%20(schema)>)
class EnvironmentDeleteResponse: …
environments: List\[Environment] expression: str Link to this property locked\_on\_deployment: Optional\[bool] Link to this property name: str Link to this property position: ListCursor Link to this property ref: str Link to this property version: Optional\[int] formatint64 Link to this property http\_application\_id: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.environments%20%3E%20(model)%20environment_delete_response%20%3E%20(schema)>)
class EnvironmentRollbackResponse: …
environments: List\[Environment] expression: str Link to this property locked\_on\_deployment: Optional\[bool] Link to this property name: str Link to this property position: ListCursor Link to this property ref: str Link to this property version: Optional\[int] formatint64 Link to this property http\_application\_id: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.environments%20%3E%20(model)%20environment_rollback_response%20%3E%20(schema)>) #### ZonesCustom Nameservers ##### [Get Account Custom Nameserver Related Zone Metadata](https://developers.cloudflare.com/api/python/resources/zones/subresources/custom_nameservers/methods/get) Deprecated zones.custom\_nameservers.get(CustomNameserverGetParams\*\*kwargs) -> [CustomNameserverGetResponse]() GET/zones/{zone\_id}/custom\_ns ##### [Set Account Custom Nameserver Related Zone Metadata](https://developers.cloudflare.com/api/python/resources/zones/subresources/custom_nameservers/methods/update) Deprecated zones.custom\_nameservers.update(CustomNameserverUpdateParams\*\*kwargs) -> SyncSinglePage\[[CustomNameserverUpdateResponse]()] PUT/zones/{zone\_id}/custom\_ns ##### ModelsExpand Collapse
class CustomNameserverGetResponse: …
errors: List\[Error] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[ErrorSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: List\[Message] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[MessageSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property success: Literal\[true] Whether the API call was successful. Link to this property enabled: Optional\[bool] Whether zone uses account-level custom nameservers. Link to this property ns\_set: Optional\[float] The number of the name server set to assign to the zone. maximum5 minimum1 Link to this property
result\_info: Optional\[ResultInfo] count: Optional\[float] Total number of results for the requested service. Link to this property page: Optional\[float] Current page within paginated list of results. Link to this property per\_page: Optional\[float] Number of results per page of results. Link to this property total\_count: Optional\[float] Total results available without any search parameters. Link to this property total\_pages: Optional\[float] The number of total pages in the entire result set. Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.custom_nameservers%20%3E%20(model)%20custom_nameserver_get_response%20%3E%20(schema)>) str Unused [Link to this property](<#(resource)%20zones.custom_nameservers%20%3E%20(model)%20custom_nameserver_update_response%20%3E%20(schema)>) #### ZonesHolds ##### [Get Zone Hold](https://developers.cloudflare.com/api/python/resources/zones/subresources/holds/methods/get) zones.holds.get(HoldGetParams\*\*kwargs) -> [ZoneHold]() GET/zones/{zone\_id}/hold ##### [Create Zone Hold](https://developers.cloudflare.com/api/python/resources/zones/subresources/holds/methods/create) zones.holds.create(HoldCreateParams\*\*kwargs) -> [ZoneHold]() POST/zones/{zone\_id}/hold ##### [Update Zone Hold](https://developers.cloudflare.com/api/python/resources/zones/subresources/holds/methods/edit) zones.holds.edit(HoldEditParams\*\*kwargs) -> [ZoneHold]() PATCH/zones/{zone\_id}/hold ##### [Remove Zone Hold](https://developers.cloudflare.com/api/python/resources/zones/subresources/holds/methods/delete) zones.holds.delete(HoldDeleteParams\*\*kwargs) -> [ZoneHold]() DELETE/zones/{zone\_id}/hold ##### ModelsExpand Collapse
class ZoneHold: … hold: Optional\[bool] Link to this property hold\_after: Optional\[str] Link to this property include\_subdomains: Optional\[str] Link to this property
[Link to this property](<#(resource)%20zones.holds%20%3E%20(model)%20zone_hold%20%3E%20(schema)>) #### ZonesSubscriptions ##### [Zone Subscription Details](https://developers.cloudflare.com/api/python/resources/zones/subresources/subscriptions/methods/get) zones.subscriptions.get(SubscriptionGetParams\*\*kwargs) -> [SubscriptionGetResponse]() GET/zones/{zone\_id}/subscription ##### [Create Zone Subscription](https://developers.cloudflare.com/api/python/resources/zones/subresources/subscriptions/methods/create) zones.subscriptions.create(SubscriptionCreateParams\*\*kwargs) -> [SubscriptionCreateResponse]() POST/zones/{zone\_id}/subscription ##### [Update Zone Subscription](https://developers.cloudflare.com/api/python/resources/zones/subresources/subscriptions/methods/update) zones.subscriptions.update(SubscriptionUpdateParams\*\*kwargs) -> [SubscriptionUpdateResponse]() PUT/zones/{zone\_id}/subscription ##### ModelsExpand Collapse
class SubscriptionGetResponse: … id: Optional\[str] Subscription identifier tag. maxLength32 Link to this property currency: Optional\[str] The monetary unit in which pricing information is displayed. Link to this property current\_period\_end: Optional\[datetime] The end of the current period and also when the next billing is due. formatdate-time Link to this property current\_period\_start: Optional\[datetime] When the current billing period started. May match initial\_period\_start if this is the first period. formatdate-time Link to this property
frequency: Optional\[Literal\["weekly", "monthly", "quarterly", 2 more]] How often the subscription is renewed automatically. One of the following: "weekly" Link to this property "monthly" Link to this property "quarterly" Link to this property "yearly" Link to this property "not-applicable" Link to this property
Link to this property price: Optional\[float] The price of the subscription that will be billed, in US dollars. Link to this property rate\_plan: Optional\[RatePlan] The rate plan applied to the subscription. Link to this property
state: Optional\[Literal\["Trial", "Provisioned", "Paid", 4 more]] The state that the subscription is in. One of the following: "Trial" Link to this property "Provisioned" Link to this property "Paid" Link to this property "AwaitingPayment" Link to this property "Cancelled" Link to this property "Failed" Link to this property "Expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_get_response%20%3E%20(schema)>)
class SubscriptionCreateResponse: … id: Optional\[str] Subscription identifier tag. maxLength32 Link to this property currency: Optional\[str] The monetary unit in which pricing information is displayed. Link to this property current\_period\_end: Optional\[datetime] The end of the current period and also when the next billing is due. formatdate-time Link to this property current\_period\_start: Optional\[datetime] When the current billing period started. May match initial\_period\_start if this is the first period. formatdate-time Link to this property
frequency: Optional\[Literal\["weekly", "monthly", "quarterly", 2 more]] How often the subscription is renewed automatically. One of the following: "weekly" Link to this property "monthly" Link to this property "quarterly" Link to this property "yearly" Link to this property "not-applicable" Link to this property
Link to this property price: Optional\[float] The price of the subscription that will be billed, in US dollars. Link to this property rate\_plan: Optional\[RatePlan] The rate plan applied to the subscription. Link to this property
state: Optional\[Literal\["Trial", "Provisioned", "Paid", 4 more]] The state that the subscription is in. One of the following: "Trial" Link to this property "Provisioned" Link to this property "Paid" Link to this property "AwaitingPayment" Link to this property "Cancelled" Link to this property "Failed" Link to this property "Expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_create_response%20%3E%20(schema)>)
class SubscriptionUpdateResponse: … id: Optional\[str] Subscription identifier tag. maxLength32 Link to this property currency: Optional\[str] The monetary unit in which pricing information is displayed. Link to this property current\_period\_end: Optional\[datetime] The end of the current period and also when the next billing is due. formatdate-time Link to this property current\_period\_start: Optional\[datetime] When the current billing period started. May match initial\_period\_start if this is the first period. formatdate-time Link to this property
frequency: Optional\[Literal\["weekly", "monthly", "quarterly", 2 more]] How often the subscription is renewed automatically. One of the following: "weekly" Link to this property "monthly" Link to this property "quarterly" Link to this property "yearly" Link to this property "not-applicable" Link to this property
Link to this property price: Optional\[float] The price of the subscription that will be billed, in US dollars. Link to this property rate\_plan: Optional\[RatePlan] The rate plan applied to the subscription. Link to this property
state: Optional\[Literal\["Trial", "Provisioned", "Paid", 4 more]] The state that the subscription is in. One of the following: "Trial" Link to this property "Provisioned" Link to this property "Paid" Link to this property "AwaitingPayment" Link to this property "Cancelled" Link to this property "Failed" Link to this property "Expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)>) #### ZonesPlans ##### [List Available Plans](https://developers.cloudflare.com/api/python/resources/zones/subresources/plans/methods/list) zones.plans.list(PlanListParams\*\*kwargs) -> SyncSinglePage\[[AvailableRatePlan]()] GET/zones/{zone\_id}/available\_plans ##### [Available Plan Details](https://developers.cloudflare.com/api/python/resources/zones/subresources/plans/methods/get) zones.plans.get(strplan\_identifier, PlanGetParams\*\*kwargs) -> [AvailableRatePlan]() GET/zones/{zone\_id}/available\_plans/{plan\_identifier} ##### ModelsExpand Collapse
class AvailableRatePlan: … id: Optional\[str] Identifier maxLength32 Link to this property can\_subscribe: Optional\[bool] Indicates whether you can subscribe to this plan. Link to this property currency: Optional\[str] The monetary unit in which pricing information is displayed. Link to this property externally\_managed: Optional\[bool] Indicates whether this plan is managed externally. Link to this property
frequency: Optional\[Literal\["weekly", "monthly", "quarterly", "yearly"]] The frequency at which you will be billed for this plan. One of the following: "weekly" Link to this property "monthly" Link to this property "quarterly" Link to this property "yearly" Link to this property
Link to this property is\_subscribed: Optional\[bool] Indicates whether you are currently subscribed to this plan. Link to this property legacy\_id: Optional\[str] The legacy identifier for this rate plan, if any. Link to this property name: Optional\[str] The plan name. maxLength80 Link to this property price: Optional\[float] The amount you will be billed for this plan. Link to this property
[Link to this property](<#(resource)%20zones.plans%20%3E%20(model)%20available_rate_plan%20%3E%20(schema)>) #### ZonesRate Plans ##### [List Available Rate Plans](https://developers.cloudflare.com/api/python/resources/zones/subresources/rate_plans/methods/get) zones.rate\_plans.get(RatePlanGetParams\*\*kwargs) -> SyncSinglePage\[[RatePlanGetResponse]()] GET/zones/{zone\_id}/available\_rate\_plans ##### ModelsExpand Collapse
class RatePlanGetResponse: … id: Optional\[str] Plan identifier tag. Link to this property
components: Optional\[List\[Component]] Array of available components values for the plan. default: Optional\[float] The default amount allocated. Link to this property
name: Optional\[Literal\["zones", "page\_rules", "dedicated\_certificates", "dedicated\_certificates\_custom"]] The unique component. One of the following: "zones" Link to this property "page\_rules" Link to this property "dedicated\_certificates" Link to this property "dedicated\_certificates\_custom" Link to this property
Link to this property unit\_price: Optional\[float] The unit price of the component. Link to this property
Link to this property currency: Optional\[str] The monetary unit in which pricing information is displayed. Link to this property duration: Optional\[float] The duration of the plan subscription. Link to this property
frequency: Optional\[Literal\["weekly", "monthly", "quarterly", "yearly"]] The frequency at which you will be billed for this plan. One of the following: "weekly" Link to this property "monthly" Link to this property "quarterly" Link to this property "yearly" Link to this property
Link to this property name: Optional\[str] The plan name. maxLength80 Link to this property
[Link to this property](<#(resource)%20zones.rate_plans%20%3E%20(model)%20rate_plan_get_response%20%3E%20(schema)>) #### ZonesEntitlements ##### [Get Zone Entitlements](https://developers.cloudflare.com/api/python/resources/zones/subresources/entitlements/methods/list) zones.entitlements.list(EntitlementListParams\*\*kwargs) -> SyncSinglePage\[[EntitlementListResponse]()] GET/zones/{zone\_id}/entitlements ##### ModelsExpand Collapse
class EntitlementListResponse: … A single entitlement record for a zone or account. id: str Entitlement identifier — equal to the feature key. Link to this property
allocation: Allocation Represents the allocation value for an entitlement. The shape of value depends on type: bool uses a boolean, max_count uses an integer, enum_number uses an array of numbers, range uses an object with min and max integer fields, and string uses a string.
type: Literal\["bool", "max\_count", "enum\_number", 2 more] Allocation type discriminator. One of the following: "bool" Link to this property "max\_count" Link to this property "enum\_number" Link to this property "range" Link to this property "string" Link to this property
Link to this property
value: AllocationValue Contains the allocation value whose concrete type the type field determines: bool yields a boolean, max\_count yields an integer, enum\_number yields an array of numbers, range yields an object with min and max, and string yields a string. One of the following: bool Link to this property int Link to this property str Link to this property List\[float] Link to this property
class AllocationValueUnionMember4: … max: int Link to this property min: int Link to this property
Link to this property
Link to this property
Link to this property created\_date: str ISO 8601 timestamp (microsecond precision, no timezone offset) when the entitlement was created. Format: YYYY-MM-DDTHH:MM:SS.ffffff. Link to this property deleted\_date: str ISO 8601 timestamp when the entitlement was deleted, or empty string if not deleted. Link to this property edited\_date: str ISO 8601 timestamp (microsecond precision, no timezone offset) when the entitlement was last edited. Link to this property
feature: Feature Describes a product feature associated with an entitlement. id: int Numeric identifier of the feature. formatint64 Link to this property feature\_set: str The logical grouping (set) this feature belongs to. Link to this property key: str Unique string key for the feature. Link to this property name: str Human-readable name of the feature. Link to this property
Link to this property
[Link to this property](<#(resource)%20zones.entitlements%20%3E%20(model)%20entitlement_list_response%20%3E%20(schema)>) #### ZonesCT #### ZonesCTAlerting ##### [Get CT Alerting Subscription](https://developers.cloudflare.com/api/python/resources/zones/subresources/ct/subresources/alerting/methods/get) zones.ct.alerting.get(AlertingGetParams\*\*kwargs) -> [CTAlertingSubscription]() GET/zones/{zone\_id}/ct/alerting ##### [Update CT Alerting Subscription](https://developers.cloudflare.com/api/python/resources/zones/subresources/ct/subresources/alerting/methods/edit) zones.ct.alerting.edit(AlertingEditParams\*\*kwargs) -> [CTAlertingSubscription]() PATCH/zones/{zone\_id}/ct/alerting ##### ModelsExpand Collapse
class CTAlertingSubscription: … Certificate Transparency alerting subscription settings for a zone. enabled: bool Whether CT alerting is enabled for the zone. Link to this property emails: Optional\[List\[str]] Email addresses that receive CT alert notifications for the zone. A maximum of 100 addresses may be configured. Each address must be a valid RFC 5322 email address and must not contain a comma. Link to this property
[Link to this property](<#(resource)%20zones.ct.alerting%20%3E%20(model)%20ct_alerting_subscription%20%3E%20(schema)>)