Method |
Description |
|
advanced_ddos ( string $zone_identifier ) |
Advanced DDOS setting (permission needed: #zone_settings:read)
Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. |
|
always_online ( string $zone_identifier ) |
Get Always Online setting (permission needed: #zone_settings:read)
When enabled, Always Online will serve pages from our cache if your server is offline
(https://support.cloudflare.com/hc/en-us/articles/200168006) |
|
browser_cache_ttl ( string $zone_identifier ) |
Get Browser Cache TTL setting (permission needed: #zone_settings:read)
Browser Cache TTL (in seconds) specifies how long CloudFlare-cached resources will remain on your visitors' computers. |
|
browser_check ( string $zone_identifier ) |
Get Browser Check setting (permission needed: #zone_settings:read)
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. |
|
cache_level ( string $zone_identifier ) |
Get Cache Level setting (permission needed: #zone_settings:read)
Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). |
|
challenge_ttl ( string $zone_identifier ) |
Get Challenge TTL setting (permission needed: #zone_settings:read)
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. |
|
change_always_on ( string $zone_identifier, string | null $value = null ) |
Change Always Online setting (permission needed: #zone_settings:edit)
When enabled, Always Online will serve pages from our cache if your server is offline (https://support.cloudflare.com/hc/en-us/articles/200168006) |
|
change_browser_cache_ttl ( string $zone_identifier, integer | null $value = null ) |
Change Browser Cache TTL setting (permission needed: #zone_settings:edit)
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. |
|
change_browser_check ( string $zone_identifier, string | null $value = null ) |
Change Browser Check setting (permission needed: #zone_settings:edit)
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. |
|
change_cache_level ( string $zone_identifier, string | null $value = null ) |
Change Cache Level setting (permission needed: #zone_settings:edit)
Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). |
|
change_challenge_ttl ( string $zone_identifier, integer | null $value = null ) |
Change Challenge TTL setting (permission needed: #zone_settings:edit)
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. |
|
change_development_mode ( string $zone_identifier, string | null $value = null ) |
Change Development Mode setting (permission needed: #zone_settings:edit)
Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. |
|
change_hotlink_protection ( string $zone_identifier, string | null $value = null ) |
Change Hotlink Protection setting (permission needed: #zone_settings:edit)
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. |
|
change_ip_geolocation ( string $zone_identifier, string | null $value = null ) |
Change IP Geolocation setting (permission needed: #zone_settings:edit)
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) |
|
change_ipv6 ( string $zone_identifier, string | null $value = null ) |
Change IPv6 setting (permission needed: #zone_settings:edit)
Enable IPv6 on all subdomains that are CloudFlare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586) |
|
change_minify ( string $zone_identifier, string | null $value ) |
Change Minify setting (permission needed: #zone_settings:edit)
Automatically minify certain assets for your website (https://support.cloudflare.com/hc/en-us/articles/200168196). |
|
change_mirage ( string $zone_identifier, string | null $value = null ) |
Change Mirage setting (permission needed: #zone_settings:edit)
Automatically optimize image loading for website visitors on mobile devices (http://blog.cloudflare.com/mirage2-solving-mobile-speed). |
|
change_mobile_redirect ( string $zone_identifier, string | null $value ) |
Change Mobile Redirect setting (permission needed: #zone_settings:edit)
Automatically redirect visitors on mobile devices to a mobile-optimized subdomain (https://support.cloudflare.com/hc/en-us/articles/200168336). |
|
change_origin_error_page_pass_thru ( string $zone_identifier, string | null $value = null ) |
Change Enable Error Pages On setting (permission needed: #zone_settings:edit)
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. |
|
change_polish ( string $zone_identifier, string | null $value = null ) |
Change Polish setting (permission needed: #zone_settings:edit)
Strips 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. |
|
change_prefetch_preload ( string $zone_identifier, string | null $value = null ) |
Change Prefetch Preload setting (permission needed: #zone_settings:edit)
CloudFlare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. |
|
change_response_buffering ( string $zone_identifier, string | null $value = null ) |
Change Response Buffering setting (permission needed: #zone_settings:edit)
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. |
|
change_rocket_loader ( string $zone_identifier, string | null $value = null ) |
Change Rocket Loader setting (permission needed: #zone_settings:edit)
Rocket Loader is a general-purpose asynchronous JavaScript loader coupled with a lightweight virtual browser which can safely run any JavaScript code after window.onload. Turning on Rocket Loader will immediately improve a web page's window.onload time (assuming there is JavaScript on the page), which can have a positive impact on your Google search ranking. |
|
change_security_header ( string $zone_identifier, string | null $value ) |
Change Security Header (HSTS) setting (permission needed: #zone_settings:edit)
CloudFlare security header for a zone. |
|
change_security_level ( string $zone_identifier, string | null $value = null ) |
Change Security Level setting (permission needed: #zone_settings:edit)
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. |
|
change_server_side_exclude ( string $zone_identifier, string | null $value = null ) |
Change Server Side Exclude setting (permission needed: #zone_settings:edit)
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. |
|
change_sort_query_string_for_cache ( string $zone_identifier, string | null $value = null ) |
Change Enable Query String Sort setting (permission needed: #zone_settings:edit)
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. |
|
change_ssl ( string $zone_identifier, string | null $value = null ) |
Change SSL setting (permission needed: #zone_settings:edit)
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. |
|
change_tls_1_2_only ( string $zone_identifier, string | null $value = null ) |
Change TLS 1.2 setting (permission needed: #zone_settings:edit)
Enable Crypto TLS 1.2 feature for this zone and prevent use of previous versions. This is limited to Enterprise or Business Zones. |
|
change_tls_client_auth ( string $zone_identifier, string | null $value = null ) |
Change TLS Client Auth setting (permission needed: #zone_settings:edit)
TLS Client Auth requires CloudFlare to connect to your origin server using a client certificate (Enterprise Only) |
|
change_true_client_ip_header ( string $zone_identifier, string | null $value = null ) |
Change True Client IP setting (permission needed: #zone_settings:edit)
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. |
|
change_waf ( string $zone_identifier, string | null $value = null ) |
Change Web Application Firewall (WAF) (permission needed: #zone_settings:edit)
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. |
|
development_mode ( string $zone_identifier ) |
Get Development Mode setting (permission needed: #zone_settings:read)
Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. |
|
edit ( string $zone_identifier, array $items ) |
Get Web Application Firewall (WAF) setting (permission needed: #zone_settings:edit)
Edit settings for a zone |
|
email_obfuscation ( string $zone_identifier ) |
Get Email Obfuscation setting (permission needed: #zone_settings:read)
Encrypt email adresses on your web page from bots, while keeping them visible to humans. |
|
hotlink_protection ( string $zone_identifier ) |
Get Hotlink Protection setting (permission needed: #zone_settings:read)
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. |
|
ip_geolocation ( string $zone_identifier ) |
Get IP Geolocation setting (permission needed: #zone_settings:read)
Enable IP Geolocation to have CloudFlare geolocate visitors to your website and pass the country code to you. |
|
ipv6 ( string $zone_identifier ) |
Get IP IPv6 setting (permission needed: #zone_settings:read)
Enable IPv6 on all subdomains that are CloudFlare enabled. |
|
minify ( string $zone_identifier ) |
Get IP Minify setting (permission needed: #zone_settings:read)
Automatically minify certain assets for your website (https://support.cloudflare.com/hc/en-us/articles/200168196). |
|
mirage ( string $zone_identifier ) |
Get Mirage setting (permission needed: #zone_settings:read)
Automatically optimize image loading for website visitors on mobile devices (http://blog.cloudflare.com/mirage2-solving-mobile-speed). |
|
mobile_redirect ( string $zone_identifier ) |
Get Mobile Redirect setting (permission needed: #zone_settings:read)
Automatically redirect visitors on mobile devices to a mobile-optimized subdomain (https://support.cloudflare.com/hc/en-us/articles/200168336). |
|
origin_error_page_pass_thru ( string $zone_identifier ) |
Get Enable Error Pages On setting (permission needed: #zone_settings:read)
CloudFlare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default CloudFlare error page. |
|
polish ( string $zone_identifier ) |
Get Polish setting (permission needed: #zone_settings:read)
Strips 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. |
|
prefetch_preload ( string $zone_identifier ) |
Get Prefetch Preload setting (permission needed: #zone_settings:read)
CloudFlare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. |
|
response_buffering ( string $zone_identifier ) |
Get Response Buffering setting (permission needed: #zone_settings:read)
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. |
|
rocket_loader ( string $zone_identifier ) |
Get Rocket Loader setting (permission needed: #zone_settings:read)
Rocket Loader is a general-purpose asynchronous JavaScript loader coupled with a lightweight virtual browser which can safely run any JavaScript code after window.onload. |
|
security_header ( string $zone_identifier ) |
Get Security Header (HSTS) setting (permission needed: #zone_settings:read)
CloudFlare security header for a zone. |
|
security_level ( string $zone_identifier ) |
Get Security Level setting (permission needed: #zone_settings:read)
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. |
|
server_side_exclude ( string $zone_identifier ) |
Get Server Side Exclude setting (permission needed: #zone_settings:read)
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: . |
|
settings ( string $zone_identifier ) |
Zone settings (permission needed: #zone_settings:read)
Available settings for your user in relation to a zone |
|
sort_query_string_for_cache ( string $zone_identifier ) |
Get Enable Query String Sort setting (permission needed: #zone_settings:read)
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. |
|
ssl ( string $zone_identifier ) |
Get SSL setting (permission needed: #zone_settings:read)
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. |
|
tls_1_2_only ( string $zone_identifier ) |
Get Zone Enable TLS 1.2 setting (permission needed: #zone_settings:read)
Enable Crypto TLS 1.2 feature for this zone and prevent use of previous versions. This is limited to Enterprise or Business Zones. |
|
tls_client_auth ( string $zone_identifier ) |
Get TLS Client Auth setting (permission needed: #zone_settings:read)
TLS Client Auth requires CloudFlare to connect to your origin server using a client certificate (Enterprise Only) |
|
true_client_ip_header ( string $zone_identifier ) |
Get True Client IP setting (permission needed: #zone_settings:edit)
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. |
|
waf ( string $zone_identifier ) |
Get Web Application Firewall (WAF) setting (permission needed: #zone_settings:read)
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. |
|