--- title: Get zone setting --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Zones](https://developers.cloudflare.com/api/go/resources/zones) [Settings](https://developers.cloudflare.com/api/go/resources/zones/subresources/settings) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get zone setting client.Zones.Settings.Get(ctx, settingID, query) (\*[SettingGetResponse](), error) GET/zones/{zone\_id}/settings/{setting\_id} Fetch a single zone setting by name ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Zone Settings Write``Zone Settings Read` ##### ParametersExpand Collapse settingID string Setting name [Link to this property](<#(resource)%20zones.settings%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20setting_id%20%3E%20(schema)>)
query SettingGetParams ZoneID param.Field\[string] Identifier maxLength32 Link to this property
[Link to this property](<#(resource)%20zones.settings%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type SettingGetResponse interface{…} 0-RTT session resumption enabled for this zone. One of the following:
type ZeroRTT struct{…} 0-RTT session resumption enabled for this zone. ID ZeroRTTID ID of the zone setting. Link to this property
Value ZeroRTTValue Current value of the zone setting. One of the following: const ZeroRTTValueOn ZeroRTTValue = "on" Link to this property const ZeroRTTValueOff ZeroRTTValue = "off" Link to this property
Link to this property
Editable ZeroRTTEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const ZeroRTTEditableTrue ZeroRTTEditable = true Link to this property const ZeroRTTEditableFalse ZeroRTTEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type AdvancedDDoS struct{…} 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 AdvancedDDoSID ID of the zone setting. Link to this property
Value AdvancedDDoSValue Current value of the zone setting. One of the following: const AdvancedDDoSValueOn AdvancedDDoSValue = "on" Link to this property const AdvancedDDoSValueOff AdvancedDDoSValue = "off" Link to this property
Link to this property
Editable AdvancedDDoSEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const AdvancedDDoSEditableTrue AdvancedDDoSEditable = true Link to this property const AdvancedDDoSEditableFalse AdvancedDDoSEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesCacheRulesAegis struct{…} 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 SettingGetResponseZonesCacheRulesAegisID ID of the zone setting. Link to this property ModifiedOn TimeOptional Last time this setting was modified. formatdate-time Link to this property
Value SettingGetResponseZonesCacheRulesAegisValueOptional Value of the zone setting. Enabled boolOptional Whether the feature is enabled or not. Link to this property PoolID stringOptional 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
type AlwaysOnline struct{…} 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 AlwaysOnlineID ID of the zone setting. Link to this property
Value AlwaysOnlineValue Current value of the zone setting. One of the following: const AlwaysOnlineValueOn AlwaysOnlineValue = "on" Link to this property const AlwaysOnlineValueOff AlwaysOnlineValue = "off" Link to this property
Link to this property
Editable AlwaysOnlineEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const AlwaysOnlineEditableTrue AlwaysOnlineEditable = true Link to this property const AlwaysOnlineEditableFalse AlwaysOnlineEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesAlwaysUseHTTPS2 struct{…} 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 SettingGetResponseZonesAlwaysUseHTTPS2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesAlwaysUseHTTPS2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesAlwaysUseHTTPS2ValueOn SettingGetResponseZonesAlwaysUseHTTPS2Value = "on" Link to this property const SettingGetResponseZonesAlwaysUseHTTPS2ValueOff SettingGetResponseZonesAlwaysUseHTTPS2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesAlwaysUseHTTPS2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesAlwaysUseHTTPS2EditableTrue SettingGetResponseZonesAlwaysUseHTTPS2Editable = true Link to this property const SettingGetResponseZonesAlwaysUseHTTPS2EditableFalse SettingGetResponseZonesAlwaysUseHTTPS2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesAutomaticHTTPSRewrites2 struct{…} Enable the Automatic HTTPS Rewrites feature for this zone. ID SettingGetResponseZonesAutomaticHTTPSRewrites2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesAutomaticHTTPSRewrites2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesAutomaticHTTPSRewrites2ValueOn SettingGetResponseZonesAutomaticHTTPSRewrites2Value = "on" Link to this property const SettingGetResponseZonesAutomaticHTTPSRewrites2ValueOff SettingGetResponseZonesAutomaticHTTPSRewrites2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesAutomaticHTTPSRewrites2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesAutomaticHTTPSRewrites2EditableTrue SettingGetResponseZonesAutomaticHTTPSRewrites2Editable = true Link to this property const SettingGetResponseZonesAutomaticHTTPSRewrites2EditableFalse SettingGetResponseZonesAutomaticHTTPSRewrites2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type Brotli struct{…} When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. ID BrotliID ID of the zone setting. Link to this property
Value BrotliValue Current value of the zone setting. One of the following: const BrotliValueOff BrotliValue = "off" Link to this property const BrotliValueOn BrotliValue = "on" Link to this property
Link to this property
Editable BrotliEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const BrotliEditableTrue BrotliEditable = true Link to this property const BrotliEditableFalse BrotliEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesBrowserCacheTTL2 struct{…} 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 SettingGetResponseZonesBrowserCacheTTL2ID ID of the zone setting. Link to this property Value int64 Current value of the zone setting. maximum31536000 minimum0 Link to this property
Editable SettingGetResponseZonesBrowserCacheTTL2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesBrowserCacheTTL2EditableTrue SettingGetResponseZonesBrowserCacheTTL2Editable = true Link to this property const SettingGetResponseZonesBrowserCacheTTL2EditableFalse SettingGetResponseZonesBrowserCacheTTL2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesBrowserCheck2 struct{…} 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 SettingGetResponseZonesBrowserCheck2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesBrowserCheck2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesBrowserCheck2ValueOn SettingGetResponseZonesBrowserCheck2Value = "on" Link to this property const SettingGetResponseZonesBrowserCheck2ValueOff SettingGetResponseZonesBrowserCheck2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesBrowserCheck2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesBrowserCheck2EditableTrue SettingGetResponseZonesBrowserCheck2Editable = true Link to this property const SettingGetResponseZonesBrowserCheck2EditableFalse SettingGetResponseZonesBrowserCheck2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesCacheLevel2 struct{…} 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 SettingGetResponseZonesCacheLevel2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesCacheLevel2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesCacheLevel2ValueAggressive SettingGetResponseZonesCacheLevel2Value = "aggressive" Link to this property const SettingGetResponseZonesCacheLevel2ValueBasic SettingGetResponseZonesCacheLevel2Value = "basic" Link to this property const SettingGetResponseZonesCacheLevel2ValueSimplified SettingGetResponseZonesCacheLevel2Value = "simplified" Link to this property
Link to this property
Editable SettingGetResponseZonesCacheLevel2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesCacheLevel2EditableTrue SettingGetResponseZonesCacheLevel2Editable = true Link to this property const SettingGetResponseZonesCacheLevel2EditableFalse SettingGetResponseZonesCacheLevel2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type ChallengeTTL struct{…} 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 ChallengeTTLID ID of the zone setting. Link to this property
Value ChallengeTTLValue Current value of the zone setting. One of the following: const ChallengeTTLValue300 ChallengeTTLValue = 300 Link to this property const ChallengeTTLValue900 ChallengeTTLValue = 900 Link to this property const ChallengeTTLValue1800 ChallengeTTLValue = 1800 Link to this property const ChallengeTTLValue2700 ChallengeTTLValue = 2700 Link to this property const ChallengeTTLValue3600 ChallengeTTLValue = 3600 Link to this property const ChallengeTTLValue7200 ChallengeTTLValue = 7200 Link to this property const ChallengeTTLValue10800 ChallengeTTLValue = 10800 Link to this property const ChallengeTTLValue14400 ChallengeTTLValue = 14400 Link to this property const ChallengeTTLValue28800 ChallengeTTLValue = 28800 Link to this property const ChallengeTTLValue57600 ChallengeTTLValue = 57600 Link to this property const ChallengeTTLValue86400 ChallengeTTLValue = 86400 Link to this property const ChallengeTTLValue604800 ChallengeTTLValue = 604800 Link to this property const ChallengeTTLValue2592000 ChallengeTTLValue = 2592000 Link to this property const ChallengeTTLValue31536000 ChallengeTTLValue = 31536000 Link to this property
Link to this property
Editable ChallengeTTLEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const ChallengeTTLEditableTrue ChallengeTTLEditable = true Link to this property const ChallengeTTLEditableFalse ChallengeTTLEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesChinaNetworkEnabled struct{…} Determines whether or not the china network is enabled. ID SettingGetResponseZonesChinaNetworkEnabledID ID of the zone setting. Link to this property
Value SettingGetResponseZonesChinaNetworkEnabledValue Current value of the zone setting. One of the following: const SettingGetResponseZonesChinaNetworkEnabledValueOn SettingGetResponseZonesChinaNetworkEnabledValue = "on" Link to this property const SettingGetResponseZonesChinaNetworkEnabledValueOff SettingGetResponseZonesChinaNetworkEnabledValue = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesChinaNetworkEnabledEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesChinaNetworkEnabledEditableTrue SettingGetResponseZonesChinaNetworkEnabledEditable = true Link to this property const SettingGetResponseZonesChinaNetworkEnabledEditableFalse SettingGetResponseZonesChinaNetworkEnabledEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesContentConverter struct{…} 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 SettingGetResponseZonesContentConverterID ID of the zone setting. Link to this property
Value SettingGetResponseZonesContentConverterValue Current value of the zone setting. One of the following: const SettingGetResponseZonesContentConverterValueOff SettingGetResponseZonesContentConverterValue = "off" Link to this property const SettingGetResponseZonesContentConverterValueOn SettingGetResponseZonesContentConverterValue = "on" Link to this property
Link to this property
Editable SettingGetResponseZonesContentConverterEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesContentConverterEditableTrue SettingGetResponseZonesContentConverterEditable = true Link to this property const SettingGetResponseZonesContentConverterEditableFalse SettingGetResponseZonesContentConverterEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type Ciphers struct{…} An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. ID CiphersID ID of the zone setting. Link to this property Value \[]string Current value of the zone setting. Link to this property
Editable CiphersEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const CiphersEditableTrue CiphersEditable = true Link to this property const CiphersEditableFalse CiphersEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesCNAMEFlattening struct{…} Whether or not cname flattening is on. ID SettingGetResponseZonesCNAMEFlatteningID How to flatten the cname destination. Link to this property
DeprecatedValue SettingGetResponseZonesCNAMEFlatteningValue 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: const SettingGetResponseZonesCNAMEFlatteningValueFlattenAtRoot SettingGetResponseZonesCNAMEFlatteningValue = "flatten\_at\_root" Link to this property const SettingGetResponseZonesCNAMEFlatteningValueFlattenAll SettingGetResponseZonesCNAMEFlatteningValue = "flatten\_all" Link to this property
Link to this property
Editable SettingGetResponseZonesCNAMEFlatteningEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesCNAMEFlatteningEditableTrue SettingGetResponseZonesCNAMEFlatteningEditable = true Link to this property const SettingGetResponseZonesCNAMEFlatteningEditableFalse SettingGetResponseZonesCNAMEFlatteningEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type DevelopmentMode struct{…} 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 DevelopmentModeID ID of the zone setting. Link to this property
Value DevelopmentModeValue Current value of the zone setting. One of the following: const DevelopmentModeValueOn DevelopmentModeValue = "on" Link to this property const DevelopmentModeValueOff DevelopmentModeValue = "off" Link to this property
Link to this property
Editable DevelopmentModeEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const DevelopmentModeEditableTrue DevelopmentModeEditable = true Link to this property const DevelopmentModeEditableFalse DevelopmentModeEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property TimeRemaining float64Optional 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
type EarlyHints struct{…} 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 EarlyHintsID ID of the zone setting. Link to this property
Value EarlyHintsValue Current value of the zone setting. One of the following: const EarlyHintsValueOn EarlyHintsValue = "on" Link to this property const EarlyHintsValueOff EarlyHintsValue = "off" Link to this property
Link to this property
Editable EarlyHintsEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const EarlyHintsEditableTrue EarlyHintsEditable = true Link to this property const EarlyHintsEditableFalse EarlyHintsEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesEdgeCacheTTL2 struct{…} Time (in seconds) that a resource will be ensured to remain on Cloudflare’s cache servers. ID SettingGetResponseZonesEdgeCacheTTL2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesEdgeCacheTTL2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesEdgeCacheTTL2Value30 SettingGetResponseZonesEdgeCacheTTL2Value = 30 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value60 SettingGetResponseZonesEdgeCacheTTL2Value = 60 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value300 SettingGetResponseZonesEdgeCacheTTL2Value = 300 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value1200 SettingGetResponseZonesEdgeCacheTTL2Value = 1200 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value1800 SettingGetResponseZonesEdgeCacheTTL2Value = 1800 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value3600 SettingGetResponseZonesEdgeCacheTTL2Value = 3600 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value7200 SettingGetResponseZonesEdgeCacheTTL2Value = 7200 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value10800 SettingGetResponseZonesEdgeCacheTTL2Value = 10800 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value14400 SettingGetResponseZonesEdgeCacheTTL2Value = 14400 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value18000 SettingGetResponseZonesEdgeCacheTTL2Value = 18000 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value28800 SettingGetResponseZonesEdgeCacheTTL2Value = 28800 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value43200 SettingGetResponseZonesEdgeCacheTTL2Value = 43200 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value57600 SettingGetResponseZonesEdgeCacheTTL2Value = 57600 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value72000 SettingGetResponseZonesEdgeCacheTTL2Value = 72000 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value86400 SettingGetResponseZonesEdgeCacheTTL2Value = 86400 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value172800 SettingGetResponseZonesEdgeCacheTTL2Value = 172800 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value259200 SettingGetResponseZonesEdgeCacheTTL2Value = 259200 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value345600 SettingGetResponseZonesEdgeCacheTTL2Value = 345600 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value432000 SettingGetResponseZonesEdgeCacheTTL2Value = 432000 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value518400 SettingGetResponseZonesEdgeCacheTTL2Value = 518400 Link to this property const SettingGetResponseZonesEdgeCacheTTL2Value604800 SettingGetResponseZonesEdgeCacheTTL2Value = 604800 Link to this property
Link to this property
Editable SettingGetResponseZonesEdgeCacheTTL2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesEdgeCacheTTL2EditableTrue SettingGetResponseZonesEdgeCacheTTL2Editable = true Link to this property const SettingGetResponseZonesEdgeCacheTTL2EditableFalse SettingGetResponseZonesEdgeCacheTTL2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesEmailObfuscation2 struct{…} 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 SettingGetResponseZonesEmailObfuscation2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesEmailObfuscation2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesEmailObfuscation2ValueOn SettingGetResponseZonesEmailObfuscation2Value = "on" Link to this property const SettingGetResponseZonesEmailObfuscation2ValueOff SettingGetResponseZonesEmailObfuscation2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesEmailObfuscation2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesEmailObfuscation2EditableTrue SettingGetResponseZonesEmailObfuscation2Editable = true Link to this property const SettingGetResponseZonesEmailObfuscation2EditableFalse SettingGetResponseZonesEmailObfuscation2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type H2Prioritization struct{…} 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 H2PrioritizationID ID of the zone setting. Link to this property
Value H2PrioritizationValue Current value of the zone setting. One of the following: const H2PrioritizationValueOn H2PrioritizationValue = "on" Link to this property const H2PrioritizationValueOff H2PrioritizationValue = "off" Link to this property const H2PrioritizationValueCustom H2PrioritizationValue = "custom" Link to this property
Link to this property
Editable H2PrioritizationEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const H2PrioritizationEditableTrue H2PrioritizationEditable = true Link to this property const H2PrioritizationEditableFalse H2PrioritizationEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type HotlinkProtection struct{…} 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 HotlinkProtectionID ID of the zone setting. Link to this property
Value HotlinkProtectionValue Current value of the zone setting. One of the following: const HotlinkProtectionValueOn HotlinkProtectionValue = "on" Link to this property const HotlinkProtectionValueOff HotlinkProtectionValue = "off" Link to this property
Link to this property
Editable HotlinkProtectionEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const HotlinkProtectionEditableTrue HotlinkProtectionEditable = true Link to this property const HotlinkProtectionEditableFalse HotlinkProtectionEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type HTTP2 struct{…} HTTP2 enabled for this zone. ID HTTP2ID ID of the zone setting. Link to this property
Value HTTP2Value Current value of the zone setting. One of the following: const HTTP2ValueOn HTTP2Value = "on" Link to this property const HTTP2ValueOff HTTP2Value = "off" Link to this property
Link to this property
Editable HTTP2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const HTTP2EditableTrue HTTP2Editable = true Link to this property const HTTP2EditableFalse HTTP2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type HTTP3 struct{…} HTTP3 enabled for this zone. ID HTTP3ID ID of the zone setting. Link to this property
Value HTTP3Value Current value of the zone setting. One of the following: const HTTP3ValueOn HTTP3Value = "on" Link to this property const HTTP3ValueOff HTTP3Value = "off" Link to this property
Link to this property
Editable HTTP3EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const HTTP3EditableTrue HTTP3Editable = true Link to this property const HTTP3EditableFalse HTTP3Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type ImageResizing struct{…} 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 ImageResizingID ID of the zone setting. Link to this property
Value ImageResizingValue Current value of the zone setting. One of the following: const ImageResizingValueOn ImageResizingValue = "on" Link to this property const ImageResizingValueOff ImageResizingValue = "off" Link to this property const ImageResizingValueOpen ImageResizingValue = "open" Link to this property
Link to this property
Editable ImageResizingEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const ImageResizingEditableTrue ImageResizingEditable = true Link to this property const ImageResizingEditableFalse ImageResizingEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesIPGeolocation2 struct{…} 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 SettingGetResponseZonesIPGeolocation2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesIPGeolocation2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesIPGeolocation2ValueOn SettingGetResponseZonesIPGeolocation2Value = "on" Link to this property const SettingGetResponseZonesIPGeolocation2ValueOff SettingGetResponseZonesIPGeolocation2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesIPGeolocation2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesIPGeolocation2EditableTrue SettingGetResponseZonesIPGeolocation2Editable = true Link to this property const SettingGetResponseZonesIPGeolocation2EditableFalse SettingGetResponseZonesIPGeolocation2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type IPV6 struct{…} Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). ID IPV6ID ID of the zone setting. Link to this property
Value IPV6Value Current value of the zone setting. One of the following: const IPV6ValueOff IPV6Value = "off" Link to this property const IPV6ValueOn IPV6Value = "on" Link to this property
Link to this property
Editable IPV6EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const IPV6EditableTrue IPV6Editable = true Link to this property const IPV6EditableFalse IPV6Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesMaxUpload struct{…} Maximum size of an allowable upload. ID SettingGetResponseZonesMaxUploadID identifier of the zone setting. Link to this property
Value SettingGetResponseZonesMaxUploadValue Current value of the zone setting. One of the following: const SettingGetResponseZonesMaxUploadValue100 SettingGetResponseZonesMaxUploadValue = 100 Link to this property const SettingGetResponseZonesMaxUploadValue125 SettingGetResponseZonesMaxUploadValue = 125 Link to this property const SettingGetResponseZonesMaxUploadValue150 SettingGetResponseZonesMaxUploadValue = 150 Link to this property const SettingGetResponseZonesMaxUploadValue175 SettingGetResponseZonesMaxUploadValue = 175 Link to this property const SettingGetResponseZonesMaxUploadValue200 SettingGetResponseZonesMaxUploadValue = 200 Link to this property const SettingGetResponseZonesMaxUploadValue225 SettingGetResponseZonesMaxUploadValue = 225 Link to this property const SettingGetResponseZonesMaxUploadValue250 SettingGetResponseZonesMaxUploadValue = 250 Link to this property const SettingGetResponseZonesMaxUploadValue275 SettingGetResponseZonesMaxUploadValue = 275 Link to this property const SettingGetResponseZonesMaxUploadValue300 SettingGetResponseZonesMaxUploadValue = 300 Link to this property const SettingGetResponseZonesMaxUploadValue325 SettingGetResponseZonesMaxUploadValue = 325 Link to this property const SettingGetResponseZonesMaxUploadValue350 SettingGetResponseZonesMaxUploadValue = 350 Link to this property const SettingGetResponseZonesMaxUploadValue375 SettingGetResponseZonesMaxUploadValue = 375 Link to this property const SettingGetResponseZonesMaxUploadValue400 SettingGetResponseZonesMaxUploadValue = 400 Link to this property const SettingGetResponseZonesMaxUploadValue425 SettingGetResponseZonesMaxUploadValue = 425 Link to this property const SettingGetResponseZonesMaxUploadValue450 SettingGetResponseZonesMaxUploadValue = 450 Link to this property const SettingGetResponseZonesMaxUploadValue475 SettingGetResponseZonesMaxUploadValue = 475 Link to this property const SettingGetResponseZonesMaxUploadValue500 SettingGetResponseZonesMaxUploadValue = 500 Link to this property const SettingGetResponseZonesMaxUploadValue1000 SettingGetResponseZonesMaxUploadValue = 1000 Link to this property const SettingGetResponseZonesMaxUploadValue1500 SettingGetResponseZonesMaxUploadValue = 1500 Link to this property const SettingGetResponseZonesMaxUploadValue2000 SettingGetResponseZonesMaxUploadValue = 2000 Link to this property const SettingGetResponseZonesMaxUploadValue2500 SettingGetResponseZonesMaxUploadValue = 2500 Link to this property const SettingGetResponseZonesMaxUploadValue3000 SettingGetResponseZonesMaxUploadValue = 3000 Link to this property const SettingGetResponseZonesMaxUploadValue3500 SettingGetResponseZonesMaxUploadValue = 3500 Link to this property const SettingGetResponseZonesMaxUploadValue4000 SettingGetResponseZonesMaxUploadValue = 4000 Link to this property const SettingGetResponseZonesMaxUploadValue4500 SettingGetResponseZonesMaxUploadValue = 4500 Link to this property const SettingGetResponseZonesMaxUploadValue5000 SettingGetResponseZonesMaxUploadValue = 5000 Link to this property
Link to this property
Editable SettingGetResponseZonesMaxUploadEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesMaxUploadEditableTrue SettingGetResponseZonesMaxUploadEditable = true Link to this property const SettingGetResponseZonesMaxUploadEditableFalse SettingGetResponseZonesMaxUploadEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type MinTLSVersion struct{…} 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 MinTLSVersionID ID of the zone setting. Link to this property
Value MinTLSVersionValue Current value of the zone setting. One of the following: const MinTLSVersionValue1\_0 MinTLSVersionValue = "1.0" Link to this property const MinTLSVersionValue1\_1 MinTLSVersionValue = "1.1" Link to this property const MinTLSVersionValue1\_2 MinTLSVersionValue = "1.2" Link to this property const MinTLSVersionValue1\_3 MinTLSVersionValue = "1.3" Link to this property
Link to this property
Editable MinTLSVersionEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const MinTLSVersionEditableTrue MinTLSVersionEditable = true Link to this property const MinTLSVersionEditableFalse MinTLSVersionEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesMirage2 struct{…} Automatically optimize image loading for website visitors on mobile devices. Refer to our blog post for more information. ID SettingGetResponseZonesMirage2ID ID of the zone setting. Link to this property
DeprecatedValue SettingGetResponseZonesMirage2Value 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: const SettingGetResponseZonesMirage2ValueOn SettingGetResponseZonesMirage2Value = "on" Link to this property const SettingGetResponseZonesMirage2ValueOff SettingGetResponseZonesMirage2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesMirage2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesMirage2EditableTrue SettingGetResponseZonesMirage2Editable = true Link to this property const SettingGetResponseZonesMirage2EditableFalse SettingGetResponseZonesMirage2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type NEL struct{…} Enable Network Error Logging reporting on your zone. (Beta) ID NELID Zone setting identifier. Link to this property
Value NELValue Current value of the zone setting. Enabled boolOptional Link to this property
Link to this property
Editable NELEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const NELEditableTrue NELEditable = true Link to this property const NELEditableFalse NELEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesOpportunisticEncryption2 struct{…} Enables the Opportunistic Encryption feature for a zone. ID SettingGetResponseZonesOpportunisticEncryption2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesOpportunisticEncryption2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesOpportunisticEncryption2ValueOn SettingGetResponseZonesOpportunisticEncryption2Value = "on" Link to this property const SettingGetResponseZonesOpportunisticEncryption2ValueOff SettingGetResponseZonesOpportunisticEncryption2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesOpportunisticEncryption2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesOpportunisticEncryption2EditableTrue SettingGetResponseZonesOpportunisticEncryption2Editable = true Link to this property const SettingGetResponseZonesOpportunisticEncryption2EditableFalse SettingGetResponseZonesOpportunisticEncryption2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type OpportunisticOnion struct{…} Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. ID OpportunisticOnionID ID of the zone setting. Link to this property
Value OpportunisticOnionValue Current value of the zone setting. One of the following: const OpportunisticOnionValueOn OpportunisticOnionValue = "on" Link to this property const OpportunisticOnionValueOff OpportunisticOnionValue = "off" Link to this property
Link to this property
Editable OpportunisticOnionEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const OpportunisticOnionEditableTrue OpportunisticOnionEditable = true Link to this property const OpportunisticOnionEditableFalse OpportunisticOnionEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type OrangeToOrange struct{…} Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. ID OrangeToOrangeID ID of the zone setting. Link to this property
DeprecatedValue OrangeToOrangeValue 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: const OrangeToOrangeValueOn OrangeToOrangeValue = "on" Link to this property const OrangeToOrangeValueOff OrangeToOrangeValue = "off" Link to this property
Link to this property
Editable OrangeToOrangeEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const OrangeToOrangeEditableTrue OrangeToOrangeEditable = true Link to this property const OrangeToOrangeEditableFalse OrangeToOrangeEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesOriginErrorPagePassThru2 struct{…} 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 SettingGetResponseZonesOriginErrorPagePassThru2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesOriginErrorPagePassThru2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesOriginErrorPagePassThru2ValueOn SettingGetResponseZonesOriginErrorPagePassThru2Value = "on" Link to this property const SettingGetResponseZonesOriginErrorPagePassThru2ValueOff SettingGetResponseZonesOriginErrorPagePassThru2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesOriginErrorPagePassThru2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesOriginErrorPagePassThru2EditableTrue SettingGetResponseZonesOriginErrorPagePassThru2Editable = true Link to this property const SettingGetResponseZonesOriginErrorPagePassThru2EditableFalse SettingGetResponseZonesOriginErrorPagePassThru2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesCacheRulesOriginH2MaxStreams struct{…} 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 SettingGetResponseZonesCacheRulesOriginH2MaxStreamsID Value of the zone setting. Link to this property ModifiedOn TimeOptional Last time this setting was modified. formatdate-time Link to this property Value int64Optional Value of the Origin H2 Max Streams Setting. maximum1000 minimum1 Link to this property
Link to this property
type SettingGetResponseZonesCacheRulesOriginMaxHTTPVersion struct{…} 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 SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionID Value of the zone setting. Link to this property ModifiedOn TimeOptional Last time this setting was modified. formatdate-time Link to this property
Value SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValueOptional Value of the Origin Max HTTP Version Setting. One of the following: const SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue2 SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue = "2" Link to this property const SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue1 SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue = "1" Link to this property
Link to this property
Link to this property
type SettingGetResponseZonesPolish2 struct{…} 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 SettingGetResponseZonesPolish2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesPolish2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesPolish2ValueOff SettingGetResponseZonesPolish2Value = "off" Link to this property const SettingGetResponseZonesPolish2ValueLossless SettingGetResponseZonesPolish2Value = "lossless" Link to this property const SettingGetResponseZonesPolish2ValueLossy SettingGetResponseZonesPolish2Value = "lossy" Link to this property
Link to this property
Editable SettingGetResponseZonesPolish2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesPolish2EditableTrue SettingGetResponseZonesPolish2Editable = true Link to this property const SettingGetResponseZonesPolish2EditableFalse SettingGetResponseZonesPolish2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type PrefetchPreload struct{…} Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. ID PrefetchPreloadID ID of the zone setting. Link to this property
Value PrefetchPreloadValue Current value of the zone setting. One of the following: const PrefetchPreloadValueOn PrefetchPreloadValue = "on" Link to this property const PrefetchPreloadValueOff PrefetchPreloadValue = "off" Link to this property
Link to this property
Editable PrefetchPreloadEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const PrefetchPreloadEditableTrue PrefetchPreloadEditable = true Link to this property const PrefetchPreloadEditableFalse PrefetchPreloadEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesPreRender struct{…} When enabled, Cloudflare serves pre-rendered HTML to eligible search and AI crawlers instead of the origin’s unrendered response. ID SettingGetResponseZonesPreRenderID ID of the zone setting. Link to this property
Value SettingGetResponseZonesPreRenderValue Current value of the zone setting. One of the following: const SettingGetResponseZonesPreRenderValueOff SettingGetResponseZonesPreRenderValue = "off" Link to this property const SettingGetResponseZonesPreRenderValueOn SettingGetResponseZonesPreRenderValue = "on" Link to this property
Link to this property
Editable SettingGetResponseZonesPreRenderEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesPreRenderEditableTrue SettingGetResponseZonesPreRenderEditable = true Link to this property const SettingGetResponseZonesPreRenderEditableFalse SettingGetResponseZonesPreRenderEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesPrivacyPass struct{…} 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 SettingGetResponseZonesPrivacyPassID ID of the zone setting. Link to this property
DeprecatedValue SettingGetResponseZonesPrivacyPassValue 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: const SettingGetResponseZonesPrivacyPassValueOn SettingGetResponseZonesPrivacyPassValue = "on" Link to this property const SettingGetResponseZonesPrivacyPassValueOff SettingGetResponseZonesPrivacyPassValue = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesPrivacyPassEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesPrivacyPassEditableTrue SettingGetResponseZonesPrivacyPassEditable = true Link to this property const SettingGetResponseZonesPrivacyPassEditableFalse SettingGetResponseZonesPrivacyPassEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type ProxyReadTimeout struct{…} Maximum time between two read operations from origin. ID ProxyReadTimeoutID ID of the zone setting. Link to this property Value float64 Current value of the zone setting. Link to this property
Editable ProxyReadTimeoutEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const ProxyReadTimeoutEditableTrue ProxyReadTimeoutEditable = true Link to this property const ProxyReadTimeoutEditableFalse ProxyReadTimeoutEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type PseudoIPV4 struct{…} The value set for the Pseudo IPv4 setting. ID PseudoIPV4ID Value of the Pseudo IPv4 setting. Link to this property
Value PseudoIPV4Value Current value of the zone setting. One of the following: const PseudoIPV4ValueOff PseudoIPV4Value = "off" Link to this property const PseudoIPV4ValueAddHeader PseudoIPV4Value = "add\_header" Link to this property const PseudoIPV4ValueOverwriteHeader PseudoIPV4Value = "overwrite\_header" Link to this property
Link to this property
Editable PseudoIPV4EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const PseudoIPV4EditableTrue PseudoIPV4Editable = true Link to this property const PseudoIPV4EditableFalse PseudoIPV4Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesRedirectsForAITraining struct{…} 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 SettingGetResponseZonesRedirectsForAITrainingID ID of the zone setting. Link to this property
Value SettingGetResponseZonesRedirectsForAITrainingValue Current value of the zone setting. One of the following: const SettingGetResponseZonesRedirectsForAITrainingValueOff SettingGetResponseZonesRedirectsForAITrainingValue = "off" Link to this property const SettingGetResponseZonesRedirectsForAITrainingValueOn SettingGetResponseZonesRedirectsForAITrainingValue = "on" Link to this property
Link to this property
Editable SettingGetResponseZonesRedirectsForAITrainingEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesRedirectsForAITrainingEditableTrue SettingGetResponseZonesRedirectsForAITrainingEditable = true Link to this property const SettingGetResponseZonesRedirectsForAITrainingEditableFalse SettingGetResponseZonesRedirectsForAITrainingEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesReplaceInsecureJS struct{…} 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 SettingGetResponseZonesReplaceInsecureJSID ID of the zone setting. Link to this property
Value SettingGetResponseZonesReplaceInsecureJSValue Current value of the zone setting. One of the following: const SettingGetResponseZonesReplaceInsecureJSValueOn SettingGetResponseZonesReplaceInsecureJSValue = "on" Link to this property const SettingGetResponseZonesReplaceInsecureJSValueOff SettingGetResponseZonesReplaceInsecureJSValue = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesReplaceInsecureJSEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesReplaceInsecureJSEditableTrue SettingGetResponseZonesReplaceInsecureJSEditable = true Link to this property const SettingGetResponseZonesReplaceInsecureJSEditableFalse SettingGetResponseZonesReplaceInsecureJSEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesResponseBuffering2 struct{…} 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 SettingGetResponseZonesResponseBuffering2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesResponseBuffering2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesResponseBuffering2ValueOn SettingGetResponseZonesResponseBuffering2Value = "on" Link to this property const SettingGetResponseZonesResponseBuffering2ValueOff SettingGetResponseZonesResponseBuffering2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesResponseBuffering2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesResponseBuffering2EditableTrue SettingGetResponseZonesResponseBuffering2Editable = true Link to this property const SettingGetResponseZonesResponseBuffering2EditableFalse SettingGetResponseZonesResponseBuffering2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesRocketLoader2 struct{…} 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 SettingGetResponseZonesRocketLoader2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesRocketLoader2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesRocketLoader2ValueOn SettingGetResponseZonesRocketLoader2Value = "on" Link to this property const SettingGetResponseZonesRocketLoader2ValueOff SettingGetResponseZonesRocketLoader2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesRocketLoader2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesRocketLoader2EditableTrue SettingGetResponseZonesRocketLoader2Editable = true Link to this property const SettingGetResponseZonesRocketLoader2EditableFalse SettingGetResponseZonesRocketLoader2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesSchemasAutomaticPlatformOptimization struct{…} Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare’s edge network and caches third-party fonts. ID SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID ID of the zone setting. Link to this property
Value AutomaticPlatformOptimization Current value of the zone setting. CacheByDeviceType 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 \[]string 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 WpPlugin bool Indicates whether or not Cloudflare for WordPress plugin is installed. Link to this property
Link to this property
Editable SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditableTrue SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable = true Link to this property const SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditableFalse SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesSearchForAgents struct{…} 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 SettingGetResponseZonesSearchForAgentsID ID of the zone setting. Link to this property
Value SettingGetResponseZonesSearchForAgentsValue Current value of the zone setting. One of the following: const SettingGetResponseZonesSearchForAgentsValueOff SettingGetResponseZonesSearchForAgentsValue = "off" Link to this property const SettingGetResponseZonesSearchForAgentsValueOn SettingGetResponseZonesSearchForAgentsValue = "on" Link to this property
Link to this property
Editable SettingGetResponseZonesSearchForAgentsEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesSearchForAgentsEditableTrue SettingGetResponseZonesSearchForAgentsEditable = true Link to this property const SettingGetResponseZonesSearchForAgentsEditableFalse SettingGetResponseZonesSearchForAgentsEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SecurityHeaders struct{…} Cloudflare security header for a zone. ID SecurityHeadersID ID of the zone’s security header. Link to this property
Value SecurityHeadersValue Current value of the zone setting.
StrictTransportSecurity SecurityHeadersValueStrictTransportSecurityOptional Strict Transport Security. Enabled boolOptional Whether or not strict transport security is enabled. Link to this property IncludeSubdomains boolOptional Include all subdomains for strict transport security. Link to this property MaxAge float64Optional Max age in seconds of the strict transport security. Link to this property Nosniff boolOptional Whether or not to include ‘X-Content-Type-Options: nosniff’ header. Link to this property Preload boolOptional Enable automatic preload of the HSTS configuration. Link to this property
Link to this property
Link to this property
Editable SecurityHeadersEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SecurityHeadersEditableTrue SecurityHeadersEditable = true Link to this property const SecurityHeadersEditableFalse SecurityHeadersEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesSecurityLevel2 struct{…} 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 SettingGetResponseZonesSecurityLevel2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesSecurityLevel2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesSecurityLevel2ValueOff SettingGetResponseZonesSecurityLevel2Value = "off" Link to this property const SettingGetResponseZonesSecurityLevel2ValueEssentiallyOff SettingGetResponseZonesSecurityLevel2Value = "essentially\_off" Link to this property const SettingGetResponseZonesSecurityLevel2ValueLow SettingGetResponseZonesSecurityLevel2Value = "low" Link to this property const SettingGetResponseZonesSecurityLevel2ValueMedium SettingGetResponseZonesSecurityLevel2Value = "medium" Link to this property const SettingGetResponseZonesSecurityLevel2ValueHigh SettingGetResponseZonesSecurityLevel2Value = "high" Link to this property const SettingGetResponseZonesSecurityLevel2ValueUnderAttack SettingGetResponseZonesSecurityLevel2Value = "under\_attack" Link to this property
Link to this property
Editable SettingGetResponseZonesSecurityLevel2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesSecurityLevel2EditableTrue SettingGetResponseZonesSecurityLevel2Editable = true Link to this property const SettingGetResponseZonesSecurityLevel2EditableFalse SettingGetResponseZonesSecurityLevel2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type ServerSideExcludes struct{…} 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 ServerSideExcludesID ID of the zone setting. Link to this property
Value ServerSideExcludesValue Current value of the zone setting. One of the following: const ServerSideExcludesValueOn ServerSideExcludesValue = "on" Link to this property const ServerSideExcludesValueOff ServerSideExcludesValue = "off" Link to this property
Link to this property
Editable ServerSideExcludesEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const ServerSideExcludesEditableTrue ServerSideExcludesEditable = true Link to this property const ServerSideExcludesEditableFalse ServerSideExcludesEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesSha1Support struct{…} Allow SHA1 support. ID SettingGetResponseZonesSha1SupportID Zone setting identifier. Link to this property
Value SettingGetResponseZonesSha1SupportValue Current value of the zone setting. One of the following: const SettingGetResponseZonesSha1SupportValueOff SettingGetResponseZonesSha1SupportValue = "off" Link to this property const SettingGetResponseZonesSha1SupportValueOn SettingGetResponseZonesSha1SupportValue = "on" Link to this property
Link to this property
Editable SettingGetResponseZonesSha1SupportEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesSha1SupportEditableTrue SettingGetResponseZonesSha1SupportEditable = true Link to this property const SettingGetResponseZonesSha1SupportEditableFalse SettingGetResponseZonesSha1SupportEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesSortQueryStringForCache2 struct{…} 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 SettingGetResponseZonesSortQueryStringForCache2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesSortQueryStringForCache2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesSortQueryStringForCache2ValueOn SettingGetResponseZonesSortQueryStringForCache2Value = "on" Link to this property const SettingGetResponseZonesSortQueryStringForCache2ValueOff SettingGetResponseZonesSortQueryStringForCache2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesSortQueryStringForCache2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesSortQueryStringForCache2EditableTrue SettingGetResponseZonesSortQueryStringForCache2Editable = true Link to this property const SettingGetResponseZonesSortQueryStringForCache2EditableFalse SettingGetResponseZonesSortQueryStringForCache2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesSSL2 struct{…} 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 SettingGetResponseZonesSSL2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesSSL2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesSSL2ValueOff SettingGetResponseZonesSSL2Value = "off" Link to this property const SettingGetResponseZonesSSL2ValueFlexible SettingGetResponseZonesSSL2Value = "flexible" Link to this property const SettingGetResponseZonesSSL2ValueFull SettingGetResponseZonesSSL2Value = "full" Link to this property const SettingGetResponseZonesSSL2ValueStrict SettingGetResponseZonesSSL2Value = "strict" Link to this property
Link to this property
Editable SettingGetResponseZonesSSL2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesSSL2EditableTrue SettingGetResponseZonesSSL2Editable = true Link to this property const SettingGetResponseZonesSSL2EditableFalse SettingGetResponseZonesSSL2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SSLRecommender struct{…} 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 SSLRecommenderIDOptional Enrollment value for SSL/TLS Recommender. Link to this property Enabled boolOptional ssl-recommender enrollment setting. Link to this property
Link to this property
type SettingGetResponseZonesTLS1\_2Only struct{…} Only allows TLS1.2. ID SettingGetResponseZonesTLS1\_2OnlyID Zone setting identifier. Link to this property
Value SettingGetResponseZonesTLS1\_2OnlyValue Current value of the zone setting. One of the following: const SettingGetResponseZonesTLS1\_2OnlyValueOff SettingGetResponseZonesTLS1\_2OnlyValue = "off" Link to this property const SettingGetResponseZonesTLS1\_2OnlyValueOn SettingGetResponseZonesTLS1\_2OnlyValue = "on" Link to this property
Link to this property
Editable SettingGetResponseZonesTLS1\_2OnlyEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesTLS1\_2OnlyEditableTrue SettingGetResponseZonesTLS1\_2OnlyEditable = true Link to this property const SettingGetResponseZonesTLS1\_2OnlyEditableFalse SettingGetResponseZonesTLS1\_2OnlyEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type TLS1\_3 struct{…} Enables Crypto TLS 1.3 feature for a zone. ID TLS1\_3ID ID of the zone setting. Link to this property
Value TLS1\_3Value Current value of the zone setting. One of the following: const TLS1\_3ValueOn TLS1\_3Value = "on" Link to this property const TLS1\_3ValueOff TLS1\_3Value = "off" Link to this property const TLS1\_3ValueZrt TLS1\_3Value = "zrt" Link to this property
Link to this property
Editable TLS1\_3EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const TLS1\_3EditableTrue TLS1\_3Editable = true Link to this property const TLS1\_3EditableFalse TLS1\_3Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type TLSClientAuth struct{…} TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). ID TLSClientAuthID ID of the zone setting. Link to this property
Value TLSClientAuthValue Current value of the zone setting. One of the following: const TLSClientAuthValueOn TLSClientAuthValue = "on" Link to this property const TLSClientAuthValueOff TLSClientAuthValue = "off" Link to this property
Link to this property
Editable TLSClientAuthEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const TLSClientAuthEditableTrue TLSClientAuthEditable = true Link to this property const TLSClientAuthEditableFalse TLSClientAuthEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesTransformations struct{…} 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 SettingGetResponseZonesTransformationsID ID of the zone setting. Shared between Image Transformations and Video Transformations. Link to this property
Value SettingGetResponseZonesTransformationsValue Current value of the zone setting. One of the following: const SettingGetResponseZonesTransformationsValueOn SettingGetResponseZonesTransformationsValue = "on" Link to this property const SettingGetResponseZonesTransformationsValueOff SettingGetResponseZonesTransformationsValue = "off" Link to this property const SettingGetResponseZonesTransformationsValueOpen SettingGetResponseZonesTransformationsValue = "open" Link to this property
Link to this property
Editable SettingGetResponseZonesTransformationsEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesTransformationsEditableTrue SettingGetResponseZonesTransformationsEditable = true Link to this property const SettingGetResponseZonesTransformationsEditableFalse SettingGetResponseZonesTransformationsEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesTransformationsAllowedOrigins struct{…} 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 SettingGetResponseZonesTransformationsAllowedOriginsID ID of the zone setting. Shared between Image Transformations and Video Transformations. Link to this property Value string Current value of the zone setting. Link to this property
Editable SettingGetResponseZonesTransformationsAllowedOriginsEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesTransformationsAllowedOriginsEditableTrue SettingGetResponseZonesTransformationsAllowedOriginsEditable = true Link to this property const SettingGetResponseZonesTransformationsAllowedOriginsEditableFalse SettingGetResponseZonesTransformationsAllowedOriginsEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesTrueClientIPHeader2 struct{…} 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 SettingGetResponseZonesTrueClientIPHeader2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesTrueClientIPHeader2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesTrueClientIPHeader2ValueOn SettingGetResponseZonesTrueClientIPHeader2Value = "on" Link to this property const SettingGetResponseZonesTrueClientIPHeader2ValueOff SettingGetResponseZonesTrueClientIPHeader2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesTrueClientIPHeader2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesTrueClientIPHeader2EditableTrue SettingGetResponseZonesTrueClientIPHeader2Editable = true Link to this property const SettingGetResponseZonesTrueClientIPHeader2EditableFalse SettingGetResponseZonesTrueClientIPHeader2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesWAF2 struct{…} 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 SettingGetResponseZonesWAF2ID ID of the zone setting. Link to this property
Value SettingGetResponseZonesWAF2Value Current value of the zone setting. One of the following: const SettingGetResponseZonesWAF2ValueOn SettingGetResponseZonesWAF2Value = "on" Link to this property const SettingGetResponseZonesWAF2ValueOff SettingGetResponseZonesWAF2Value = "off" Link to this property
Link to this property
Editable SettingGetResponseZonesWAF2EditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesWAF2EditableTrue SettingGetResponseZonesWAF2Editable = true Link to this property const SettingGetResponseZonesWAF2EditableFalse SettingGetResponseZonesWAF2Editable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesWebmcpEnabled struct{…} 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 SettingGetResponseZonesWebmcpEnabledID ID of the zone setting. Link to this property
Value SettingGetResponseZonesWebmcpEnabledValue Current value of the zone setting. One of the following: const SettingGetResponseZonesWebmcpEnabledValueOff SettingGetResponseZonesWebmcpEnabledValue = "off" Link to this property const SettingGetResponseZonesWebmcpEnabledValueOn SettingGetResponseZonesWebmcpEnabledValue = "on" Link to this property
Link to this property
Editable SettingGetResponseZonesWebmcpEnabledEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesWebmcpEnabledEditableTrue SettingGetResponseZonesWebmcpEnabledEditable = true Link to this property const SettingGetResponseZonesWebmcpEnabledEditableFalse SettingGetResponseZonesWebmcpEnabledEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesWebmcpMcpURL struct{…} 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 SettingGetResponseZonesWebmcpMcpURLID ID of the zone setting. Link to this property Value string Current value of the zone setting. maxLength2048 Link to this property
Editable SettingGetResponseZonesWebmcpMcpURLEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesWebmcpMcpURLEditableTrue SettingGetResponseZonesWebmcpMcpURLEditable = true Link to this property const SettingGetResponseZonesWebmcpMcpURLEditableFalse SettingGetResponseZonesWebmcpMcpURLEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type SettingGetResponseZonesWebmcpPacks struct{…} 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 SettingGetResponseZonesWebmcpPacksID ID of the zone setting. Link to this property Value string Current value of the zone setting. maxLength256 Link to this property
Editable SettingGetResponseZonesWebmcpPacksEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const SettingGetResponseZonesWebmcpPacksEditableTrue SettingGetResponseZonesWebmcpPacksEditable = true Link to this property const SettingGetResponseZonesWebmcpPacksEditableFalse SettingGetResponseZonesWebmcpPacksEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type WebP struct{…} 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 WebPID ID of the zone setting. Link to this property
Value WebPValue Current value of the zone setting. One of the following: const WebPValueOff WebPValue = "off" Link to this property const WebPValueOn WebPValue = "on" Link to this property
Link to this property
Editable WebPEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const WebPEditableTrue WebPEditable = true Link to this property const WebPEditableFalse WebPEditable = false Link to this property
Link to this property ModifiedOn TimeOptional last time this setting was modified. formatdate-time Link to this property
Link to this property
type Websocket struct{…} 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 WebsocketID ID of the zone setting. Link to this property
Value WebsocketValue Current value of the zone setting. One of the following: const WebsocketValueOff WebsocketValue = "off" Link to this property const WebsocketValueOn WebsocketValue = "on" Link to this property
Link to this property
Editable WebsocketEditableOptional Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). One of the following: const WebsocketEditableTrue WebsocketEditable = true Link to this property const WebsocketEditableFalse WebsocketEditable = false Link to this property
Link to this property ModifiedOn TimeOptional 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)%20SettingGetResponse%20%3E%20(schema)>) ### Get zone setting Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/zones" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) setting, err := client.Zones.Settings.Get( context.TODO(), "always_online", zones.SettingGetParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", setting) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "0rtt", "value": "on", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "0rtt", "value": "on", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } ```