operations_schema_validation

Creates, updates, deletes, gets or lists an operations_schema_validation resource.

Overview

Name	operations_schema_validation
Type	Resource
Id	cloudflare.api_gateway.operations_schema_validation

Fields

The following fields are returned by SELECT queries:

list_by_zone

Operation-level schema validation settings response

Name	Datatype	Description
operation_id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
mitigation_action	string	When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied (log, block, none, ) (example: block)

Methods

The following methods are available for this resource:

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

SELECT examples

list_by_zone

Retrieves operation-level schema validation settings on the zone

SELECT
operation_id,
mitigation_action
FROM cloudflare.api_gateway.operations_schema_validation
WHERE zone_id = '{{ zone_id }}' -- required
AND operation_id = '{{ operation_id }}' -- required
;

UPDATE examples

edit

Updates multiple operation-level schema validation settings on the zone

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

REPLACE examples

update_by_zone

Updates operation-level schema validation settings on the zone

REPLACE cloudflare.api_gateway.operations_schema_validation
SET 
mitigation_action = '{{ mitigation_action }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND operation_id = '{{ operation_id }}' --required
RETURNING
operation_id,
mitigation_action;