Zones
ModelsExpand Collapse
type Zone struct{…}
The last time proof of ownership was detected and the zone was made active.
The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is 0.
The domain name. Per RFC 1035 the overall zone name can be up to 253 characters, with each segment (“label”) not exceeding 63 characters.
DeprecatedPlan ZonePlanPlease use the /zones/{zone_id}/subscription API
to update a zone’s plan. Changing this value will create/cancel
associated subscriptions. To view available plans for this zone,
see Zone Plans.
A Zones subscription information.
Please use the /zones/{zone_id}/subscription API
to update a zone’s plan. Changing this value will create/cancel
associated subscriptions. To view available plans for this zone,
see Zone Plans.
A Zones subscription information.
Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits.
This has been replaced by Account memberships.
Legacy permissions based on legacy user membership information.
Tenant ZoneTenantOptionalThe root organizational unit that this zone belongs to (such as a tenant or organization).
The root organizational unit that this zone belongs to (such as a tenant or organization).
TenantUnit ZoneTenantUnitOptionalThe immediate parent organizational unit that this zone belongs to (such as under a tenant or sub-organization).
The immediate parent organizational unit that this zone belongs to (such as under a tenant or sub-organization).
A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.
ZonesActivation Check
Rerun the Activation Check
ZonesObservability
ZonesObservabilityTracing
ZonesObservabilityTracingSettings
View zone tracing settings
Update zone tracing settings
Reset zone tracing settings
ZonesObservabilityTracingRules
View zone trace rules
Replace zone trace rules
Delete zone trace rules
ZonesSettings
Get zone setting
Edit zone setting
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.
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.
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.
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.
type AutomaticPlatformOptimization struct{…}
Indicates whether or not cache by device type is enabled.
An array of hostnames where Automatic Platform Optimization for WordPress is activated.
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.
When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.
type CacheLevel struct{…}
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.
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.
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).
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).
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.
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.
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.
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.
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.
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.
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.
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.
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).
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).
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.
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.
type IPV6 struct{…}Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).
Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).
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.
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.
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.
Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.
type OrangeToOrange struct{…}Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.
Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.
type PrefetchPreload struct{…}Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.
Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.
type ProxyReadTimeout struct{…}Maximum time between two read operations from origin.
Maximum time between two read operations from origin.
type SecurityHeaders struct{…}Cloudflare security header for a zone.
Cloudflare security header for a zone.
Value SecurityHeadersValueCurrent value of the zone setting.
Current value of the zone setting.
type SecurityHeadersValueStrictTransportSecurity struct{…}
type SecurityHeadersValueStrictTransportSecurity struct{…}
type SecurityHeadersValueStrictTransportSecurity struct{…}
type SecurityHeadersValueStrictTransportSecurity struct{…}
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).
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).
type TLSClientAuth struct{…}TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).
TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).
type WAF struct{…}
Turn on or off WAF managed rules (previous version, deprecated). You cannot enable or disable individual WAF managed rules via Page Rules.
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.
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.
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.
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.
ZonesTransformations Allowed Origins
Get Image Transformations Allowed Origins setting
Change Image Transformations Allowed Origins setting
ModelsExpand Collapse
type TransformationsAllowedOrigins struct{…}Controls which origins are allowed to request image and video transformations.
Controls which origins are allowed to request image and video transformations.
Editable TransformationsAllowedOriginsEditableOptionalWhether or not this setting can be modified for this zone (based on your Cloudflare plan level).
Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).
ZonesTransformations C2pa
Get Image Transformations C2PA setting
Change Image Transformations C2PA setting
ZonesNEL
Edit NEL setting
ModelsExpand Collapse
type Setting struct{…}A zone-scoped NEL configuration setting.
A zone-scoped NEL configuration setting.
Whether the setting is editable. This is false when the zone’s plan does not include NEL or the NEL product feature is not enabled.