settings

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

Overview

Name	settings
Type	Resource
Id	cloudflare.zones.settings

Fields

The following fields are returned by SELECT queries:

get

Get zone setting response

Name	Datatype	Description
id	string	ID of the zone setting. (0rtt) (example: 0rtt)
editable	boolean	Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). (true, false)
enabled	boolean	ssl-recommender enrollment setting.
modified_on	string (date-time)	last time this setting was modified. (example: 2014-01-01T05:20:00.12345Z)
time_remaining	number	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.
value	string	Current value of the zone setting. (on, off) (example: on, default: off)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id, setting_id		Fetch a single zone setting by name
edit	update	zone_id, setting_id		Updates a single zone setting by the identifier
zone_settings_edit_zone_settings_info	update	zone_id		Edit settings for a zone.
firewall_for_ai_settings_put	replace	zone_id		Enable or disable Firewall for AI for a zone. Changes can take up to a minute to propagate to the zone.

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
setting_id	string
zone_id	string	The Cloudflare zone ID.

SELECT examples

get

Fetch a single zone setting by name

SELECT
id,
editable,
enabled,
modified_on,
time_remaining,
value
FROM cloudflare.zones.settings
WHERE zone_id = '{{ zone_id }}' -- required
AND setting_id = '{{ setting_id }}' -- required
;

UPDATE examples

edit

Updates a single zone setting by the identifier

UPDATE cloudflare.zones.settings
SET 
enabled = {{ enabled }},
value = '{{ value }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND setting_id = '{{ setting_id }}' --required
RETURNING
errors,
messages,
result,
success;

zone_settings_edit_zone_settings_info

Edit settings for a zone.

UPDATE cloudflare.zones.settings
SET 
-- No updatable properties
WHERE 
zone_id = '{{ zone_id }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

firewall_for_ai_settings_put

Enable or disable Firewall for AI for a zone. Changes can take up to a minute to propagate to the zone.

REPLACE cloudflare.zones.settings
SET 
enabled = {{ enabled }}
WHERE 
zone_id = '{{ zone_id }}' --required
RETURNING
errors,
messages,
result,
success;