configurations

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

Overview

Name	configurations
Type	Resource
Id	cloudflare.api_gateway.configurations

Fields

The following fields are returned by SELECT queries:

list

Retrieve information about specific configuration properties response

Name	Datatype	Description
name	string	The name of the characteristic field, i.e., the header or cookie name. (example: authorization)
type	string	The type of characteristic. (header, cookie) (example: header)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id	normalize	Gets the current API Shield configuration settings for a zone, including validation behavior and enforcement mode.
update	replace	zone_id, auth_id_characteristics	normalize	Updates API Shield configuration settings for a zone. Can modify validation strictness, enforcement mode, and other global settings.

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.
normalize	boolean	Ensures that the configuration is written or retrieved in normalized fashion

SELECT examples

list

Gets the current API Shield configuration settings for a zone, including validation behavior and enforcement mode.

SELECT
name,
type
FROM cloudflare.api_gateway.configurations
WHERE zone_id = '{{ zone_id }}' -- required
AND normalize = '{{ normalize }}'
;

REPLACE examples

update

Updates API Shield configuration settings for a zone. Can modify validation strictness, enforcement mode, and other global settings.

REPLACE cloudflare.api_gateway.configurations
SET 
auth_id_characteristics = '{{ auth_id_characteristics }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND auth_id_characteristics = '{{ auth_id_characteristics }}' --required
AND normalize = {{ normalize}}
RETURNING
errors,
messages,
result,
success;