API Reference

Zones

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 WriteZone Settings Read

ParametersExpand Collapse

settingID string

Setting name

query SettingGetParams

ZoneID param.Field[string]

Identifier

maxLength32

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.

Value ZeroRTTValue

Current value of the zone setting.

One of the following:

const ZeroRTTValueOn ZeroRTTValue = "on"

const ZeroRTTValueOff ZeroRTTValue = "off"

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

const ZeroRTTEditableFalse ZeroRTTEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value AdvancedDDoSValue

Current value of the zone setting.

One of the following:

const AdvancedDDoSValueOn AdvancedDDoSValue = "on"

const AdvancedDDoSValueOff AdvancedDDoSValue = "off"

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

const AdvancedDDoSEditableFalse AdvancedDDoSEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

ModifiedOn TimeOptional

Last time this setting was modified.

formatdate-time

Value SettingGetResponseZonesCacheRulesAegisValueOptional

Value of the zone setting.

Enabled boolOptional

Whether the feature is enabled or not.

PoolID stringOptional

Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin.

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.

Value AlwaysOnlineValue

Current value of the zone setting.

One of the following:

const AlwaysOnlineValueOn AlwaysOnlineValue = "on"

const AlwaysOnlineValueOff AlwaysOnlineValue = "off"

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

const AlwaysOnlineEditableFalse AlwaysOnlineEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesAlwaysUseHTTPS2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesAlwaysUseHTTPS2ValueOn SettingGetResponseZonesAlwaysUseHTTPS2Value = "on"

const SettingGetResponseZonesAlwaysUseHTTPS2ValueOff SettingGetResponseZonesAlwaysUseHTTPS2Value = "off"

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

const SettingGetResponseZonesAlwaysUseHTTPS2EditableFalse SettingGetResponseZonesAlwaysUseHTTPS2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type SettingGetResponseZonesAutomaticHTTPSRewrites2 struct{…}

Enable the Automatic HTTPS Rewrites feature for this zone.

ID SettingGetResponseZonesAutomaticHTTPSRewrites2ID

ID of the zone setting.

Value SettingGetResponseZonesAutomaticHTTPSRewrites2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesAutomaticHTTPSRewrites2ValueOn SettingGetResponseZonesAutomaticHTTPSRewrites2Value = "on"

const SettingGetResponseZonesAutomaticHTTPSRewrites2ValueOff SettingGetResponseZonesAutomaticHTTPSRewrites2Value = "off"

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

const SettingGetResponseZonesAutomaticHTTPSRewrites2EditableFalse SettingGetResponseZonesAutomaticHTTPSRewrites2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value BrotliValue

Current value of the zone setting.

One of the following:

const BrotliValueOff BrotliValue = "off"

const BrotliValueOn BrotliValue = "on"

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

const BrotliEditableFalse BrotliEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value int64

Current value of the zone setting.

maximum31536000

minimum0

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

const SettingGetResponseZonesBrowserCacheTTL2EditableFalse SettingGetResponseZonesBrowserCacheTTL2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesBrowserCheck2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesBrowserCheck2ValueOn SettingGetResponseZonesBrowserCheck2Value = "on"

const SettingGetResponseZonesBrowserCheck2ValueOff SettingGetResponseZonesBrowserCheck2Value = "off"

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

const SettingGetResponseZonesBrowserCheck2EditableFalse SettingGetResponseZonesBrowserCheck2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesCacheLevel2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesCacheLevel2ValueAggressive SettingGetResponseZonesCacheLevel2Value = "aggressive"

const SettingGetResponseZonesCacheLevel2ValueBasic SettingGetResponseZonesCacheLevel2Value = "basic"

const SettingGetResponseZonesCacheLevel2ValueSimplified SettingGetResponseZonesCacheLevel2Value = "simplified"

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

const SettingGetResponseZonesCacheLevel2EditableFalse SettingGetResponseZonesCacheLevel2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value ChallengeTTLValue

Current value of the zone setting.

One of the following:

const ChallengeTTLValue300 ChallengeTTLValue = 300

const ChallengeTTLValue900 ChallengeTTLValue = 900

const ChallengeTTLValue1800 ChallengeTTLValue = 1800

const ChallengeTTLValue2700 ChallengeTTLValue = 2700

const ChallengeTTLValue3600 ChallengeTTLValue = 3600

const ChallengeTTLValue7200 ChallengeTTLValue = 7200

const ChallengeTTLValue10800 ChallengeTTLValue = 10800

const ChallengeTTLValue14400 ChallengeTTLValue = 14400

const ChallengeTTLValue28800 ChallengeTTLValue = 28800

const ChallengeTTLValue57600 ChallengeTTLValue = 57600

const ChallengeTTLValue86400 ChallengeTTLValue = 86400

const ChallengeTTLValue604800 ChallengeTTLValue = 604800

const ChallengeTTLValue2592000 ChallengeTTLValue = 2592000

const ChallengeTTLValue31536000 ChallengeTTLValue = 31536000

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

const ChallengeTTLEditableFalse ChallengeTTLEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type SettingGetResponseZonesChinaNetworkEnabled struct{…}

Determines whether or not the china network is enabled.

ID SettingGetResponseZonesChinaNetworkEnabledID

ID of the zone setting.

Value SettingGetResponseZonesChinaNetworkEnabledValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesChinaNetworkEnabledValueOn SettingGetResponseZonesChinaNetworkEnabledValue = "on"

const SettingGetResponseZonesChinaNetworkEnabledValueOff SettingGetResponseZonesChinaNetworkEnabledValue = "off"

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

const SettingGetResponseZonesChinaNetworkEnabledEditableFalse SettingGetResponseZonesChinaNetworkEnabledEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesContentConverterValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesContentConverterValueOff SettingGetResponseZonesContentConverterValue = "off"

const SettingGetResponseZonesContentConverterValueOn SettingGetResponseZonesContentConverterValue = "on"

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

const SettingGetResponseZonesContentConverterEditableFalse SettingGetResponseZonesContentConverterEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value []string

Current value of the zone setting.

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

const CiphersEditableFalse CiphersEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type SettingGetResponseZonesCNAMEFlattening struct{…}

Whether or not cname flattening is on.

ID SettingGetResponseZonesCNAMEFlatteningID

How to flatten the cname destination.

DeprecatedValue SettingGetResponseZonesCNAMEFlatteningValue

This zone setting is deprecated; please use the DNS Settings route instead. More information at https://edgetunnel-b2h.pages.dev/fundamentals/api/reference/deprecations/#2025-03-21

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesCNAMEFlatteningValueFlattenAtRoot SettingGetResponseZonesCNAMEFlatteningValue = "flatten_at_root"

const SettingGetResponseZonesCNAMEFlatteningValueFlattenAll SettingGetResponseZonesCNAMEFlatteningValue = "flatten_all"

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

const SettingGetResponseZonesCNAMEFlatteningEditableFalse SettingGetResponseZonesCNAMEFlatteningEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value DevelopmentModeValue

Current value of the zone setting.

One of the following:

const DevelopmentModeValueOn DevelopmentModeValue = "on"

const DevelopmentModeValueOff DevelopmentModeValue = "off"

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

const DevelopmentModeEditableFalse DevelopmentModeEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

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.

Value EarlyHintsValue

Current value of the zone setting.

One of the following:

const EarlyHintsValueOn EarlyHintsValue = "on"

const EarlyHintsValueOff EarlyHintsValue = "off"

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

const EarlyHintsEditableFalse EarlyHintsEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesEdgeCacheTTL2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesEdgeCacheTTL2Value30 SettingGetResponseZonesEdgeCacheTTL2Value = 30

const SettingGetResponseZonesEdgeCacheTTL2Value60 SettingGetResponseZonesEdgeCacheTTL2Value = 60

const SettingGetResponseZonesEdgeCacheTTL2Value300 SettingGetResponseZonesEdgeCacheTTL2Value = 300

const SettingGetResponseZonesEdgeCacheTTL2Value1200 SettingGetResponseZonesEdgeCacheTTL2Value = 1200

const SettingGetResponseZonesEdgeCacheTTL2Value1800 SettingGetResponseZonesEdgeCacheTTL2Value = 1800

const SettingGetResponseZonesEdgeCacheTTL2Value3600 SettingGetResponseZonesEdgeCacheTTL2Value = 3600

const SettingGetResponseZonesEdgeCacheTTL2Value7200 SettingGetResponseZonesEdgeCacheTTL2Value = 7200

const SettingGetResponseZonesEdgeCacheTTL2Value10800 SettingGetResponseZonesEdgeCacheTTL2Value = 10800

const SettingGetResponseZonesEdgeCacheTTL2Value14400 SettingGetResponseZonesEdgeCacheTTL2Value = 14400

const SettingGetResponseZonesEdgeCacheTTL2Value18000 SettingGetResponseZonesEdgeCacheTTL2Value = 18000

const SettingGetResponseZonesEdgeCacheTTL2Value28800 SettingGetResponseZonesEdgeCacheTTL2Value = 28800

const SettingGetResponseZonesEdgeCacheTTL2Value43200 SettingGetResponseZonesEdgeCacheTTL2Value = 43200

const SettingGetResponseZonesEdgeCacheTTL2Value57600 SettingGetResponseZonesEdgeCacheTTL2Value = 57600

const SettingGetResponseZonesEdgeCacheTTL2Value72000 SettingGetResponseZonesEdgeCacheTTL2Value = 72000

const SettingGetResponseZonesEdgeCacheTTL2Value86400 SettingGetResponseZonesEdgeCacheTTL2Value = 86400

const SettingGetResponseZonesEdgeCacheTTL2Value172800 SettingGetResponseZonesEdgeCacheTTL2Value = 172800

const SettingGetResponseZonesEdgeCacheTTL2Value259200 SettingGetResponseZonesEdgeCacheTTL2Value = 259200

const SettingGetResponseZonesEdgeCacheTTL2Value345600 SettingGetResponseZonesEdgeCacheTTL2Value = 345600

const SettingGetResponseZonesEdgeCacheTTL2Value432000 SettingGetResponseZonesEdgeCacheTTL2Value = 432000

const SettingGetResponseZonesEdgeCacheTTL2Value518400 SettingGetResponseZonesEdgeCacheTTL2Value = 518400

const SettingGetResponseZonesEdgeCacheTTL2Value604800 SettingGetResponseZonesEdgeCacheTTL2Value = 604800

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

const SettingGetResponseZonesEdgeCacheTTL2EditableFalse SettingGetResponseZonesEdgeCacheTTL2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesEmailObfuscation2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesEmailObfuscation2ValueOn SettingGetResponseZonesEmailObfuscation2Value = "on"

const SettingGetResponseZonesEmailObfuscation2ValueOff SettingGetResponseZonesEmailObfuscation2Value = "off"

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

const SettingGetResponseZonesEmailObfuscation2EditableFalse SettingGetResponseZonesEmailObfuscation2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value H2PrioritizationValue

Current value of the zone setting.

One of the following:

const H2PrioritizationValueOn H2PrioritizationValue = "on"

const H2PrioritizationValueOff H2PrioritizationValue = "off"

const H2PrioritizationValueCustom H2PrioritizationValue = "custom"

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

const H2PrioritizationEditableFalse H2PrioritizationEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value HotlinkProtectionValue

Current value of the zone setting.

One of the following:

const HotlinkProtectionValueOn HotlinkProtectionValue = "on"

const HotlinkProtectionValueOff HotlinkProtectionValue = "off"

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

const HotlinkProtectionEditableFalse HotlinkProtectionEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type HTTP2 struct{…}

HTTP2 enabled for this zone.

ID HTTP2ID

ID of the zone setting.

Value HTTP2Value

Current value of the zone setting.

One of the following:

const HTTP2ValueOn HTTP2Value = "on"

const HTTP2ValueOff HTTP2Value = "off"

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

const HTTP2EditableFalse HTTP2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type HTTP3 struct{…}

HTTP3 enabled for this zone.

ID HTTP3ID

ID of the zone setting.

Value HTTP3Value

Current value of the zone setting.

One of the following:

const HTTP3ValueOn HTTP3Value = "on"

const HTTP3ValueOff HTTP3Value = "off"

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

const HTTP3EditableFalse HTTP3Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value ImageResizingValue

Current value of the zone setting.

One of the following:

const ImageResizingValueOn ImageResizingValue = "on"

const ImageResizingValueOff ImageResizingValue = "off"

const ImageResizingValueOpen ImageResizingValue = "open"

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

const ImageResizingEditableFalse ImageResizingEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesIPGeolocation2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesIPGeolocation2ValueOn SettingGetResponseZonesIPGeolocation2Value = "on"

const SettingGetResponseZonesIPGeolocation2ValueOff SettingGetResponseZonesIPGeolocation2Value = "off"

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

const SettingGetResponseZonesIPGeolocation2EditableFalse SettingGetResponseZonesIPGeolocation2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value IPV6Value

Current value of the zone setting.

One of the following:

const IPV6ValueOff IPV6Value = "off"

const IPV6ValueOn IPV6Value = "on"

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

const IPV6EditableFalse IPV6Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type SettingGetResponseZonesMaxUpload struct{…}

Maximum size of an allowable upload.

ID SettingGetResponseZonesMaxUploadID

identifier of the zone setting.

Value SettingGetResponseZonesMaxUploadValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesMaxUploadValue100 SettingGetResponseZonesMaxUploadValue = 100

const SettingGetResponseZonesMaxUploadValue125 SettingGetResponseZonesMaxUploadValue = 125

const SettingGetResponseZonesMaxUploadValue150 SettingGetResponseZonesMaxUploadValue = 150

const SettingGetResponseZonesMaxUploadValue175 SettingGetResponseZonesMaxUploadValue = 175

const SettingGetResponseZonesMaxUploadValue200 SettingGetResponseZonesMaxUploadValue = 200

const SettingGetResponseZonesMaxUploadValue225 SettingGetResponseZonesMaxUploadValue = 225

const SettingGetResponseZonesMaxUploadValue250 SettingGetResponseZonesMaxUploadValue = 250

const SettingGetResponseZonesMaxUploadValue275 SettingGetResponseZonesMaxUploadValue = 275

const SettingGetResponseZonesMaxUploadValue300 SettingGetResponseZonesMaxUploadValue = 300

const SettingGetResponseZonesMaxUploadValue325 SettingGetResponseZonesMaxUploadValue = 325

const SettingGetResponseZonesMaxUploadValue350 SettingGetResponseZonesMaxUploadValue = 350

const SettingGetResponseZonesMaxUploadValue375 SettingGetResponseZonesMaxUploadValue = 375

const SettingGetResponseZonesMaxUploadValue400 SettingGetResponseZonesMaxUploadValue = 400

const SettingGetResponseZonesMaxUploadValue425 SettingGetResponseZonesMaxUploadValue = 425

const SettingGetResponseZonesMaxUploadValue450 SettingGetResponseZonesMaxUploadValue = 450

const SettingGetResponseZonesMaxUploadValue475 SettingGetResponseZonesMaxUploadValue = 475

const SettingGetResponseZonesMaxUploadValue500 SettingGetResponseZonesMaxUploadValue = 500

const SettingGetResponseZonesMaxUploadValue1000 SettingGetResponseZonesMaxUploadValue = 1000

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

const SettingGetResponseZonesMaxUploadEditableFalse SettingGetResponseZonesMaxUploadEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value MinTLSVersionValue

Current value of the zone setting.

One of the following:

const MinTLSVersionValue1_0 MinTLSVersionValue = "1.0"

const MinTLSVersionValue1_1 MinTLSVersionValue = "1.1"

const MinTLSVersionValue1_2 MinTLSVersionValue = "1.2"

const MinTLSVersionValue1_3 MinTLSVersionValue = "1.3"

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

const MinTLSVersionEditableFalse MinTLSVersionEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

DeprecatedValue SettingGetResponseZonesMirage2Value

Mirage is being deprecated. More information at https://edgetunnel-b2h.pages.dev/speed/optimization/images/mirage/

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesMirage2ValueOn SettingGetResponseZonesMirage2Value = "on"

const SettingGetResponseZonesMirage2ValueOff SettingGetResponseZonesMirage2Value = "off"

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

const SettingGetResponseZonesMirage2EditableFalse SettingGetResponseZonesMirage2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type NEL struct{…}

Enable Network Error Logging reporting on your zone. (Beta)

ID NELID

Zone setting identifier.

Value NELValue

Current value of the zone setting.

Enabled boolOptional

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

const NELEditableFalse NELEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type SettingGetResponseZonesOpportunisticEncryption2 struct{…}

Enables the Opportunistic Encryption feature for a zone.

ID SettingGetResponseZonesOpportunisticEncryption2ID

ID of the zone setting.

Value SettingGetResponseZonesOpportunisticEncryption2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesOpportunisticEncryption2ValueOn SettingGetResponseZonesOpportunisticEncryption2Value = "on"

const SettingGetResponseZonesOpportunisticEncryption2ValueOff SettingGetResponseZonesOpportunisticEncryption2Value = "off"

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

const SettingGetResponseZonesOpportunisticEncryption2EditableFalse SettingGetResponseZonesOpportunisticEncryption2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value OpportunisticOnionValue

Current value of the zone setting.

One of the following:

const OpportunisticOnionValueOn OpportunisticOnionValue = "on"

const OpportunisticOnionValueOff OpportunisticOnionValue = "off"

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

const OpportunisticOnionEditableFalse OpportunisticOnionEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value OrangeToOrangeValue

Current value of the zone setting.

One of the following:

const OrangeToOrangeValueOn OrangeToOrangeValue = "on"

const OrangeToOrangeValueOff OrangeToOrangeValue = "off"

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

const OrangeToOrangeEditableFalse OrangeToOrangeEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesOriginErrorPagePassThru2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesOriginErrorPagePassThru2ValueOn SettingGetResponseZonesOriginErrorPagePassThru2Value = "on"

const SettingGetResponseZonesOriginErrorPagePassThru2ValueOff SettingGetResponseZonesOriginErrorPagePassThru2Value = "off"

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

const SettingGetResponseZonesOriginErrorPagePassThru2EditableFalse SettingGetResponseZonesOriginErrorPagePassThru2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

ModifiedOn TimeOptional

Last time this setting was modified.

formatdate-time

Value int64Optional

Value of the Origin H2 Max Streams Setting.

maximum1000

minimum1

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.

ModifiedOn TimeOptional

Last time this setting was modified.

formatdate-time

Value SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValueOptional

Value of the Origin Max HTTP Version Setting.

One of the following:

const SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue2 SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue = "2"

const SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue1 SettingGetResponseZonesCacheRulesOriginMaxHTTPVersionValue = "1"

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.

Value SettingGetResponseZonesPolish2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesPolish2ValueOff SettingGetResponseZonesPolish2Value = "off"

const SettingGetResponseZonesPolish2ValueLossless SettingGetResponseZonesPolish2Value = "lossless"

const SettingGetResponseZonesPolish2ValueLossy SettingGetResponseZonesPolish2Value = "lossy"

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

const SettingGetResponseZonesPolish2EditableFalse SettingGetResponseZonesPolish2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value PrefetchPreloadValue

Current value of the zone setting.

One of the following:

const PrefetchPreloadValueOn PrefetchPreloadValue = "on"

const PrefetchPreloadValueOff PrefetchPreloadValue = "off"

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

const PrefetchPreloadEditableFalse PrefetchPreloadEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

DeprecatedValue SettingGetResponseZonesPrivacyPassValue

Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://edgetunnel-b2h.pages.dev/fundamentals/api/reference/deprecations/#2024-03-31)

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesPrivacyPassValueOn SettingGetResponseZonesPrivacyPassValue = "on"

const SettingGetResponseZonesPrivacyPassValueOff SettingGetResponseZonesPrivacyPassValue = "off"

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

const SettingGetResponseZonesPrivacyPassEditableFalse SettingGetResponseZonesPrivacyPassEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type ProxyReadTimeout struct{…}

Maximum time between two read operations from origin.

ID ProxyReadTimeoutID

ID of the zone setting.

Value float64

Current value of the zone setting.

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

const ProxyReadTimeoutEditableFalse ProxyReadTimeoutEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type PseudoIPV4 struct{…}

The value set for the Pseudo IPv4 setting.

ID PseudoIPV4ID

Value of the Pseudo IPv4 setting.

Value PseudoIPV4Value

Current value of the zone setting.

One of the following:

const PseudoIPV4ValueOff PseudoIPV4Value = "off"

const PseudoIPV4ValueAddHeader PseudoIPV4Value = "add_header"

const PseudoIPV4ValueOverwriteHeader PseudoIPV4Value = "overwrite_header"

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

const PseudoIPV4EditableFalse PseudoIPV4Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesRedirectsForAITrainingValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesRedirectsForAITrainingValueOff SettingGetResponseZonesRedirectsForAITrainingValue = "off"

const SettingGetResponseZonesRedirectsForAITrainingValueOn SettingGetResponseZonesRedirectsForAITrainingValue = "on"

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

const SettingGetResponseZonesRedirectsForAITrainingEditableFalse SettingGetResponseZonesRedirectsForAITrainingEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesReplaceInsecureJSValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesReplaceInsecureJSValueOn SettingGetResponseZonesReplaceInsecureJSValue = "on"

const SettingGetResponseZonesReplaceInsecureJSValueOff SettingGetResponseZonesReplaceInsecureJSValue = "off"

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

const SettingGetResponseZonesReplaceInsecureJSEditableFalse SettingGetResponseZonesReplaceInsecureJSEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesResponseBuffering2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesResponseBuffering2ValueOn SettingGetResponseZonesResponseBuffering2Value = "on"

const SettingGetResponseZonesResponseBuffering2ValueOff SettingGetResponseZonesResponseBuffering2Value = "off"

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

const SettingGetResponseZonesResponseBuffering2EditableFalse SettingGetResponseZonesResponseBuffering2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesRocketLoader2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesRocketLoader2ValueOn SettingGetResponseZonesRocketLoader2Value = "on"

const SettingGetResponseZonesRocketLoader2ValueOff SettingGetResponseZonesRocketLoader2Value = "off"

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

const SettingGetResponseZonesRocketLoader2EditableFalse SettingGetResponseZonesRocketLoader2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value AutomaticPlatformOptimization

Current value of the zone setting.

CacheByDeviceType bool

Indicates whether or not cache by device type is enabled.

Cf bool

Indicates whether or not Cloudflare proxy is enabled.

Enabled bool

Indicates whether or not Automatic Platform Optimization is enabled.

Hostnames []string

An array of hostnames where Automatic Platform Optimization for WordPress is activated.

Wordpress bool

Indicates whether or not site is powered by WordPress.

WpPlugin bool

Indicates whether or not Cloudflare for WordPress plugin is installed.

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

const SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditableFalse SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesSearchForAgentsValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesSearchForAgentsValueOff SettingGetResponseZonesSearchForAgentsValue = "off"

const SettingGetResponseZonesSearchForAgentsValueOn SettingGetResponseZonesSearchForAgentsValue = "on"

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

const SettingGetResponseZonesSearchForAgentsEditableFalse SettingGetResponseZonesSearchForAgentsEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type SecurityHeaders struct{…}

Cloudflare security header for a zone.

ID SecurityHeadersID

ID of the zone’s security header.

Value SecurityHeadersValue

Current value of the zone setting.

StrictTransportSecurity SecurityHeadersValueStrictTransportSecurityOptional

Strict Transport Security.

Enabled boolOptional

Whether or not strict transport security is enabled.

IncludeSubdomains boolOptional

Include all subdomains for strict transport security.

MaxAge float64Optional

Max age in seconds of the strict transport security.

Nosniff boolOptional

Whether or not to include ‘X-Content-Type-Options: nosniff’ header.

Preload boolOptional

Enable automatic preload of the HSTS configuration.

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

const SecurityHeadersEditableFalse SecurityHeadersEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesSecurityLevel2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesSecurityLevel2ValueOff SettingGetResponseZonesSecurityLevel2Value = "off"

const SettingGetResponseZonesSecurityLevel2ValueEssentiallyOff SettingGetResponseZonesSecurityLevel2Value = "essentially_off"

const SettingGetResponseZonesSecurityLevel2ValueLow SettingGetResponseZonesSecurityLevel2Value = "low"

const SettingGetResponseZonesSecurityLevel2ValueMedium SettingGetResponseZonesSecurityLevel2Value = "medium"

const SettingGetResponseZonesSecurityLevel2ValueHigh SettingGetResponseZonesSecurityLevel2Value = "high"

const SettingGetResponseZonesSecurityLevel2ValueUnderAttack SettingGetResponseZonesSecurityLevel2Value = "under_attack"

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

const SettingGetResponseZonesSecurityLevel2EditableFalse SettingGetResponseZonesSecurityLevel2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value ServerSideExcludesValue

Current value of the zone setting.

One of the following:

const ServerSideExcludesValueOn ServerSideExcludesValue = "on"

const ServerSideExcludesValueOff ServerSideExcludesValue = "off"

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

const ServerSideExcludesEditableFalse ServerSideExcludesEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type SettingGetResponseZonesSha1Support struct{…}

Allow SHA1 support.

ID SettingGetResponseZonesSha1SupportID

Zone setting identifier.

Value SettingGetResponseZonesSha1SupportValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesSha1SupportValueOff SettingGetResponseZonesSha1SupportValue = "off"

const SettingGetResponseZonesSha1SupportValueOn SettingGetResponseZonesSha1SupportValue = "on"

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

const SettingGetResponseZonesSha1SupportEditableFalse SettingGetResponseZonesSha1SupportEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesSortQueryStringForCache2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesSortQueryStringForCache2ValueOn SettingGetResponseZonesSortQueryStringForCache2Value = "on"

const SettingGetResponseZonesSortQueryStringForCache2ValueOff SettingGetResponseZonesSortQueryStringForCache2Value = "off"

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

const SettingGetResponseZonesSortQueryStringForCache2EditableFalse SettingGetResponseZonesSortQueryStringForCache2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesSSL2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesSSL2ValueOff SettingGetResponseZonesSSL2Value = "off"

const SettingGetResponseZonesSSL2ValueFlexible SettingGetResponseZonesSSL2Value = "flexible"

const SettingGetResponseZonesSSL2ValueFull SettingGetResponseZonesSSL2Value = "full"

const SettingGetResponseZonesSSL2ValueStrict SettingGetResponseZonesSSL2Value = "strict"

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

const SettingGetResponseZonesSSL2EditableFalse SettingGetResponseZonesSSL2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Enabled boolOptional

ssl-recommender enrollment setting.

type SettingGetResponseZonesTLS1_2Only struct{…}

Only allows TLS1.2.

ID SettingGetResponseZonesTLS1_2OnlyID

Zone setting identifier.

Value SettingGetResponseZonesTLS1_2OnlyValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesTLS1_2OnlyValueOff SettingGetResponseZonesTLS1_2OnlyValue = "off"

const SettingGetResponseZonesTLS1_2OnlyValueOn SettingGetResponseZonesTLS1_2OnlyValue = "on"

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

const SettingGetResponseZonesTLS1_2OnlyEditableFalse SettingGetResponseZonesTLS1_2OnlyEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

type TLS1_3 struct{…}

Enables Crypto TLS 1.3 feature for a zone.

ID TLS1_3ID

ID of the zone setting.

Value TLS1_3Value

Current value of the zone setting.

One of the following:

const TLS1_3ValueOn TLS1_3Value = "on"

const TLS1_3ValueOff TLS1_3Value = "off"

const TLS1_3ValueZrt TLS1_3Value = "zrt"

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

const TLS1_3EditableFalse TLS1_3Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value TLSClientAuthValue

Current value of the zone setting.

One of the following:

const TLSClientAuthValueOn TLSClientAuthValue = "on"

const TLSClientAuthValueOff TLSClientAuthValue = "off"

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

const TLSClientAuthEditableFalse TLSClientAuthEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesTransformationsValue

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesTransformationsValueOn SettingGetResponseZonesTransformationsValue = "on"

const SettingGetResponseZonesTransformationsValueOff SettingGetResponseZonesTransformationsValue = "off"

const SettingGetResponseZonesTransformationsValueOpen SettingGetResponseZonesTransformationsValue = "open"

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

const SettingGetResponseZonesTransformationsEditableFalse SettingGetResponseZonesTransformationsEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value string

Current value of the zone setting.

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

const SettingGetResponseZonesTransformationsAllowedOriginsEditableFalse SettingGetResponseZonesTransformationsAllowedOriginsEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesTrueClientIPHeader2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesTrueClientIPHeader2ValueOn SettingGetResponseZonesTrueClientIPHeader2Value = "on"

const SettingGetResponseZonesTrueClientIPHeader2ValueOff SettingGetResponseZonesTrueClientIPHeader2Value = "off"

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

const SettingGetResponseZonesTrueClientIPHeader2EditableFalse SettingGetResponseZonesTrueClientIPHeader2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value SettingGetResponseZonesWAF2Value

Current value of the zone setting.

One of the following:

const SettingGetResponseZonesWAF2ValueOn SettingGetResponseZonesWAF2Value = "on"

const SettingGetResponseZonesWAF2ValueOff SettingGetResponseZonesWAF2Value = "off"

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

const SettingGetResponseZonesWAF2EditableFalse SettingGetResponseZonesWAF2Editable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value WebPValue

Current value of the zone setting.

One of the following:

const WebPValueOff WebPValue = "off"

const WebPValueOn WebPValue = "on"

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

const WebPEditableFalse WebPEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

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.

Value WebsocketValue

Current value of the zone setting.

One of the following:

const WebsocketValueOff WebsocketValue = "off"

const WebsocketValueOn WebsocketValue = "on"

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

const WebsocketEditableFalse WebsocketEditable = false

ModifiedOn TimeOptional

last time this setting was modified.

formatdate-time

Get zone setting

Go

HTTP

TypeScript

Python

Go

Terraform

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"
  }
}