settings_schema_validation

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

Overview

Name	settings_schema_validation
Type	Resource
Id	cloudflare.api_gateway.settings_schema_validation

Fields

The following fields are returned by SELECT queries:

list_by_zone

Zone level schema validation settings response

Name	Datatype	Description
validation_default_mitigation_action	string	The default mitigation action used when there is no mitigation action defined on the operation 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 A special value of of none will skip running schema validation entirely for the request when there is no mitigation action defined on the operation (none, log, block) (example: block)
validation_override_mitigation_action	string	When set, this overrides both zone level and operation level mitigation actions. - none will skip running schema validation entirely for the request - null indicates that no override is in place (none, )

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_zone	select	zone_id		Retrieves zone level schema validation settings currently set on the zone
edit	update	zone_id		Updates zone level schema validation settings on the zone
update_by_zone	replace	zone_id, validation_default_mitigation_action		Updates zone level schema validation settings on 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
zone_id	string	The Cloudflare zone ID.

SELECT examples

list_by_zone

Retrieves zone level schema validation settings currently set on the zone

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

UPDATE examples

edit

Updates zone level schema validation settings on the zone

UPDATE cloudflare.api_gateway.settings_schema_validation
SET 
validation_default_mitigation_action = '{{ validation_default_mitigation_action }}',
validation_override_mitigation_action = '{{ validation_override_mitigation_action }}'
WHERE 
zone_id = '{{ zone_id }}' --required
RETURNING
validation_default_mitigation_action,
validation_override_mitigation_action;

REPLACE examples

update_by_zone

Updates zone level schema validation settings on the zone

REPLACE cloudflare.api_gateway.settings_schema_validation
SET 
validation_default_mitigation_action = '{{ validation_default_mitigation_action }}',
validation_override_mitigation_action = '{{ validation_override_mitigation_action }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND validation_default_mitigation_action = '{{ validation_default_mitigation_action }}' --required
RETURNING
validation_default_mitigation_action,
validation_override_mitigation_action;