settings

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

Overview

Name	settings
Type	Resource
Id	cloudflare.schema_validation.settings

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
validation_default_mitigation_action	string	The default mitigation action used Mitigation actions are as follows: - log - log request when request does not conform to schema - block - deny access to the site when request does not conform to schema - none - skip running schema validation (none, log, block) (example: block)
validation_override_mitigation_action	string	When not null, this overrides global both zone level and operation level mitigation actions. This can serve as a quick way to disable schema validation for the whole zone. - "none" will skip running schema validation entirely for the request (none)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		Retrieves the current global schema validation settings for a zone.
edit	update	zone_id		Partially updates global schema validation settings for a zone using PATCH semantics.
update	replace	zone_id		Fully updates global schema validation settings for a zone, replacing 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

Retrieves the current global schema validation settings for a zone.

SELECT
validation_default_mitigation_action,
validation_override_mitigation_action
FROM cloudflare.schema_validation.settings
WHERE zone_id = '{{ zone_id }}' -- required
;

UPDATE examples

edit

Partially updates global schema validation settings for a zone using PATCH semantics.

UPDATE cloudflare.schema_validation.settings
SET 
validation_default_mitigation_action = '{{ validation_default_mitigation_action }}',
validation_override_mitigation_action = '{{ validation_override_mitigation_action }}'
WHERE 
zone_id = '{{ zone_id }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

update

Fully updates global schema validation settings for a zone, replacing existing configuration.

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