API Reference

Zones

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Settings

Get zone setting

client.Zones.Settings.Get(ctx, settingID, query) (*SettingGetResponse, error)

GET/zones/{zone_id}/settings/{setting_id}

Edit zone setting

client.Zones.Settings.Edit(ctx, settingID, params) (*SettingEditResponse, error)

PATCH/zones/{zone_id}/settings/{setting_id}

ModelsExpand Collapse

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 Aegis 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 AegisID

ID of the zone setting.

ModifiedOn Timeoptional

Last time this setting was modified.

formatdate-time

Value AegisValueoptional

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 AlwaysUseHTTPS struct{…}

ID AlwaysUseHTTPSIDoptional

If enabled, any http://`` URL is converted to https://` through a 301 redirect.

type AutomaticHTTPSRewrites struct{…}

ID AutomaticHTTPSRewritesIDoptional

Turn on or off Automatic HTTPS Rewrites.

Value AutomaticHTTPSRewritesValueoptional

The status of Automatic HTTPS Rewrites.

One of the following:

const AutomaticHTTPSRewritesValueOn AutomaticHTTPSRewritesValue = "on"

const AutomaticHTTPSRewritesValueOff AutomaticHTTPSRewritesValue = "off"

type AutomaticPlatformOptimization struct{…}

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.

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 BrowserCacheTTL struct{…}

ID BrowserCacheTTLIDoptional

Control how long resources cached by client browsers remain valid.

Value int64optional

The number of seconds to cache resources for. Setting this to 0 enables "Respect Existing Headers".

maximum31536000

minimum0

type BrowserCheck struct{…}

ID BrowserCheckIDoptional

Inspect the visitor's browser for headers commonly associated with spammers and certain bots.

Value BrowserCheckValueoptional

The status of Browser Integrity Check.

One of the following:

const BrowserCheckValueOn BrowserCheckValue = "on"

const BrowserCheckValueOff BrowserCheckValue = "off"

type CacheLevel struct{…}

ID CacheLevelIDoptional

Apply custom caching based on the option selected.

Value CacheLevelValueoptional

• bypass: Cloudflare does not cache.
• basic: Delivers resources from cache when there is no query string.
• simplified: Delivers the same resource to everyone independent of the query string.
• aggressive: Caches all static content that has a query string.
• cache_everything: Treats all content as static and caches all file types beyond the Cloudflare default cached content.

One of the following:

const CacheLevelValueBypass CacheLevelValue = "bypass"

const CacheLevelValueBasic CacheLevelValue = "basic"

const CacheLevelValueSimplified CacheLevelValue = "simplified"

const CacheLevelValueAggressive CacheLevelValue = "aggressive"

const CacheLevelValueCacheEverything CacheLevelValue = "cache_everything"

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 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 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 EmailObfuscation struct{…}

ID EmailObfuscationIDoptional

Turn on or off Email Obfuscation.

Value EmailObfuscationValueoptional

The status of Email Obfuscation.

One of the following:

const EmailObfuscationValueOn EmailObfuscationValue = "on"

const EmailObfuscationValueOff EmailObfuscationValue = "off"

type FontSettings struct{…}

Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

ID FontSettingsIDoptional

ID of the zone setting.

Editable FontSettingsEditableoptional

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).

One of the following:

const FontSettingsEditableTrue FontSettingsEditable = true

const FontSettingsEditableFalse FontSettingsEditable = false

ModifiedOn Timeoptional

last time this setting was modified.

formatdate-time

Value FontSettingsValueoptional

Current value of the zone setting.

One of the following:

const FontSettingsValueOn FontSettingsValue = "on"

const FontSettingsValueOff FontSettingsValue = "off"

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 IPGeolocation struct{…}

ID IPGeolocationIDoptional

Cloudflare adds a CF-IPCountry HTTP header containing the country code that corresponds to the visitor.

Value IPGeolocationValueoptional

The status of adding the IP Geolocation Header.

One of the following:

const IPGeolocationValueOn IPGeolocationValue = "on"

const IPGeolocationValueOff IPGeolocationValue = "off"

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 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 Mirage struct{…}

ID MirageIDoptional

Cloudflare Mirage reduces bandwidth used by images in mobile browsers. It can accelerate loading of image-heavy websites on very slow mobile connections and HTTP/1.

Value MirageValueoptional

The status of Mirage.

One of the following:

const MirageValueOn MirageValue = "on"

const MirageValueOff MirageValue = "off"

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 OpportunisticEncryption struct{…}

ID OpportunisticEncryptionIDoptional

Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted TLS channel. It's not a substitute for HTTPS, but provides additional security for otherwise vulnerable requests.

Value OpportunisticEncryptionValueoptional

The status of Opportunistic Encryption.

One of the following:

const OpportunisticEncryptionValueOn OpportunisticEncryptionValue = "on"

const OpportunisticEncryptionValueOff OpportunisticEncryptionValue = "off"

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 OriginErrorPagePassThru struct{…}

ID OriginErrorPagePassThruIDoptional

Turn on or off Cloudflare error pages generated from issues sent from the origin server. If enabled, this setting triggers error pages issued by the origin.

Value OriginErrorPagePassThruValueoptional

The status of Origin Error Page Passthru.

One of the following:

const OriginErrorPagePassThruValueOn OriginErrorPagePassThruValue = "on"

const OriginErrorPagePassThruValueOff OriginErrorPagePassThruValue = "off"

type OriginMaxHTTPVersion struct{…}

ID OriginMaxHTTPVersionID

The identifier of the caching setting.

Editable bool

Whether the setting is editable.

Value OriginMaxHTTPVersionValue

Value of the Origin Max HTTP Version Setting.

One of the following:

const OriginMaxHTTPVersionValue2 OriginMaxHTTPVersionValue = "2"

const OriginMaxHTTPVersionValue1 OriginMaxHTTPVersionValue = "1"

ModifiedOn Timeoptional

Last time this setting was modified.

formatdate-time

type Polish struct{…}

ID PolishIDoptional

Apply options from the Polish feature of the Cloudflare Speed app.

Value PolishValueoptional

The level of Polish you want applied to your origin.

One of the following:

const PolishValueOff PolishValue = "off"

const PolishValueLossless PolishValue = "lossless"

const PolishValueLossy PolishValue = "lossy"

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 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 ResponseBuffering struct{…}

ID ResponseBufferingIDoptional

Turn on or off whether Cloudflare should wait for an entire file from the origin server before forwarding it to the site visitor. By default, Cloudflare sends packets to the client as they arrive from the origin server.

Value ResponseBufferingValueoptional

The status of Response Buffering

One of the following:

const ResponseBufferingValueOn ResponseBufferingValue = "on"

const ResponseBufferingValueOff ResponseBufferingValue = "off"

type RocketLoader struct{…}

ID RocketLoaderIDoptional

Turn on or off Rocket Loader in the Cloudflare Speed app.

Value RocketLoaderValueoptional

The status of Rocket Loader

One of the following:

const RocketLoaderValueOn RocketLoaderValue = "on"

const RocketLoaderValueOff RocketLoaderValue = "off"

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 SecurityLevel struct{…}

ID SecurityLevelIDoptional

Control options for the Security Level feature from the Security app.

Value SecurityLevelValueoptional

One of the following:

const SecurityLevelValueOff SecurityLevelValue = "off"

const SecurityLevelValueEssentiallyOff SecurityLevelValue = "essentially_off"

const SecurityLevelValueLow SecurityLevelValue = "low"

const SecurityLevelValueMedium SecurityLevelValue = "medium"

const SecurityLevelValueHigh SecurityLevelValue = "high"

const SecurityLevelValueUnderAttack SecurityLevelValue = "under_attack"

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 SortQueryStringForCache struct{…}

ID SortQueryStringForCacheIDoptional

Turn on or off the reordering of query strings. When query strings have the same structure, caching improves.

Value SortQueryStringForCacheValueoptional

The status of Query String Sort

One of the following:

const SortQueryStringForCacheValueOn SortQueryStringForCacheValue = "on"

const SortQueryStringForCacheValueOff SortQueryStringForCacheValue = "off"

type SSL struct{…}

ID SSLIDoptional

Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.

Value SSLValueoptional

The encryption mode that Cloudflare uses to connect to your origin server.

One of the following:

const SSLValueOff SSLValue = "off"

const SSLValueFlexible SSLValue = "flexible"

const SSLValueFull SSLValue = "full"

const SSLValueStrict SSLValue = "strict"

const SSLValueOriginPull SSLValue = "origin_pull"

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 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 TrueClientIPHeader struct{…}

ID TrueClientIPHeaderIDoptional

Turn on or off the True-Client-IP Header feature of the Cloudflare Network app.

Value TrueClientIPHeaderValueoptional

The status of True Client IP Header.

One of the following:

const TrueClientIPHeaderValueOn TrueClientIPHeaderValue = "on"

const TrueClientIPHeaderValueOff TrueClientIPHeaderValue = "off"

type WAF struct{…}

ID WAFIDoptional

Turn on or off WAF managed rules (previous version, deprecated). You cannot enable or disable individual WAF managed rules via Page Rules.

Value WAFValueoptional

The status of WAF managed rules (previous version).

One of the following:

const WAFValueOn WAFValue = "on"

const WAFValueOff WAFValue = "off"

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

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