access_rules_rules

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

Overview

Name	access_rules_rules
Type	Resource
Id	cloudflare.firewall.access_rules_rules

Fields

The following fields are returned by SELECT queries:

list_by_user

List IP Access rules response.

Name	Datatype	Description
id	string	The unique identifier of the IP Access rule. (example: 92f17202ed8bd63d69a66b86a49a8f6b)
allowed_modes	array	The available actions that a rule can apply to a matched request.
configuration	object	The rule configuration. (title: An IP address configuration.)
created_on	string (date-time)	The timestamp of when the rule was created. (example: 2014-01-01T05:20:00.12345Z)
mode	string	The action to apply to a matched request. (block, challenge, whitelist, js_challenge, managed_challenge) (example: challenge)
modified_on	string (date-time)	The timestamp of when the rule was last modified. (example: 2014-01-01T05:20:00.12345Z)
notes	string	An informative summary of the rule, typically used as a reminder or explanation. (example: This rule is enabled because of an event that occurred on date X.)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_user	select		mode, configuration.target, configuration.value, notes, match, page, per_page, order, direction	Fetches IP Access rules of the user. You can filter the results using several optional parameters.

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
configuration.target	string
configuration.value	string
direction	string
match	string
mode	string
notes	string
order	string
page	number
per_page	number

SELECT examples

list_by_user

Fetches IP Access rules of the user. You can filter the results using several optional parameters.

SELECT
id,
allowed_modes,
configuration,
created_on,
mode,
modified_on,
notes
FROM cloudflare.firewall.access_rules_rules
WHERE mode = '{{ mode }}'
AND configuration.target = '{{ configuration.target }}'
AND configuration.value = '{{ configuration.value }}'
AND notes = '{{ notes }}'
AND match = '{{ match }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND order = '{{ order }}'
AND direction = '{{ direction }}'
;