settings

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

Overview

Name	settings
Type	Resource
Id	cloudflare.fraud.settings

Fields

The following fields are returned by SELECT queries:

list

Fraud Detection settings response

Name	Datatype	Description
user_profiles	string	Whether Fraud User Profiles is enabled for the zone. (enabled, disabled) (example: disabled)
username_expressions	array	List of expressions to detect usernames in write HTTP requests. - Maximum of 10 expressions. - Omit or set to null to leave unchanged on update. - Provide an empty array [] to clear all expressions on update. - Invalid expressions will result in a 10400 Bad Request with details in the messages array.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		Retrieve Fraud Detection settings for a zone.
update	replace	zone_id		Update Fraud Detection settings for a zone. Notes on username_expressions behavior: - If omitted or set to null, expressions are not modified. - If provided as an empty array [], all expressions will be cleared.

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

Retrieve Fraud Detection settings for a zone.

SELECT
user_profiles,
username_expressions
FROM cloudflare.fraud.settings
WHERE zone_id = '{{ zone_id }}' -- required
;

REPLACE examples

update

Update Fraud Detection settings for a zone. Notes on username_expressions behavior: - If omitted or set to null, expressions are not modified. - If provided as an empty array [], all expressions will be cleared.

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