rules

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

Overview

Name	rules
Type	Resource
Id	cloudflare.rum.rules

Fields

The following fields are returned by SELECT queries:

list

List of Web Analytics rules in the ruleset.

Name	Datatype	Description
rules	array	A list of rules.
ruleset	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id, ruleset_id		Lists all the rules in a Web Analytics ruleset.
update	replace	account_id, ruleset_id, rule_id		Updates a rule in a Web Analytics ruleset.
delete	delete	account_id, ruleset_id, rule_id		Deletes an existing rule from a Web Analytics ruleset.

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
account_id	string	The Cloudflare account ID.
rule_id	string	The rule ID.
ruleset_id	string	The ruleset ID.

SELECT examples

list

Lists all the rules in a Web Analytics ruleset.

SELECT
rules,
ruleset
FROM cloudflare.rum.rules
WHERE account_id = '{{ account_id }}' -- required
AND ruleset_id = '{{ ruleset_id }}' -- required
;

REPLACE examples

update

Updates a rule in a Web Analytics ruleset.

REPLACE cloudflare.rum.rules
SET 
host = '{{ host }}',
inclusive = {{ inclusive }},
is_paused = {{ is_paused }},
paths = '{{ paths }}'
WHERE 
account_id = '{{ account_id }}' --required
AND ruleset_id = '{{ ruleset_id }}' --required
AND rule_id = '{{ rule_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes an existing rule from a Web Analytics ruleset.

DELETE FROM cloudflare.rum.rules
WHERE account_id = '{{ account_id }}' --required
AND ruleset_id = '{{ ruleset_id }}' --required
AND rule_id = '{{ rule_id }}' --required
;