settings

Creates, updates, deletes, gets or lists a settings resource.

Overview

Name	settings
Type	Resource
Id	cloudflare.waiting_rooms.settings

Fields

The following fields are returned by SELECT queries:

list

The current zone-level Waiting Room settings

Name	Datatype	Description
search_engine_crawler_bypass	boolean	Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appear in waiting room analytics.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		Gets the zone-level Waiting Room settings that apply as defaults to all waiting rooms on the zone.
edit	update	zone_id		Partially updates zone-level Waiting Room settings using PATCH semantics.
update	replace	zone_id		Fully updates zone-level Waiting Room settings, replacing the existing configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

Gets the zone-level Waiting Room settings that apply as defaults to all waiting rooms on the zone.

SELECT
search_engine_crawler_bypass
FROM cloudflare.waiting_rooms.settings
WHERE zone_id = '{{ zone_id }}' -- required
;

UPDATE examples

edit

Partially updates zone-level Waiting Room settings using PATCH semantics.

UPDATE cloudflare.waiting_rooms.settings
SET 
search_engine_crawler_bypass = {{ search_engine_crawler_bypass }}
WHERE 
zone_id = '{{ zone_id }}' --required
RETURNING
result;

REPLACE examples

update

Fully updates zone-level Waiting Room settings, replacing the existing configuration.

REPLACE cloudflare.waiting_rooms.settings
SET 
search_engine_crawler_bypass = {{ search_engine_crawler_bypass }}
WHERE 
zone_id = '{{ zone_id }}' --required
RETURNING
result;