rules

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

Overview

Name	rules
Type	Resource
Id	cloudflare.waiting_rooms.rules

Fields

The following fields are returned by SELECT queries:

list

List Waiting Room Rules response

Name	Datatype	Description
id	string	The ID of the rule. (example: 25756b2dfe6e378a06b033b670413757)
action	string	The action to take when the expression matches. (bypass_waiting_room) (example: bypass_waiting_room)
description	string	The description of the rule. (default: , example: allow all traffic from 10.20.30.40)
enabled	boolean	When set to true, the rule is enabled.
expression	string	Criteria defining when there is a match for the current rule. (example: ip.src in {10.20.30.40})
last_updated	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
version	string	The version of the rule. (example: 1)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	waiting_room_id, zone_id		Lists rules for a waiting room.
waiting_room_create_waiting_room_rule	insert	waiting_room_id, zone_id, action, expression		Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.
waiting_room_patch_waiting_room_rule	update	rule_id, waiting_room_id, zone_id, action, expression		Patches a rule for a waiting room.
waiting_room_replace_waiting_room_rules	replace	waiting_room_id, zone_id		Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.
waiting_room_delete_waiting_room_rule	delete	rule_id, waiting_room_id, zone_id		Deletes a rule for a waiting room.

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
rule_id	string	The rule ID.
waiting_room_id	string	The Waiting Room ID.
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

Lists rules for a waiting room.

SELECT
id,
action,
description,
enabled,
expression,
last_updated,
version
FROM cloudflare.waiting_rooms.rules
WHERE waiting_room_id = '{{ waiting_room_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;

INSERT examples

waiting_room_create_waiting_room_rule

Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.

INSERT INTO cloudflare.waiting_rooms.rules (
action,
description,
enabled,
expression,
waiting_room_id,
zone_id
)
SELECT 
'{{ action }}' /* required */,
'{{ description }}',
{{ enabled }},
'{{ expression }}' /* required */,
'{{ waiting_room_id }}',
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

Manifest

# Description fields are for documentation purposes
- name: rules
props:
  - name: waiting_room_id
    value: "{{ waiting_room_id }}"
    description: Required parameter for the rules resource.
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the rules resource.
  - name: action
    value: "{{ action }}"
    description: |
      The action to take when the expression matches.
    valid_values: ['bypass_waiting_room']
  - name: description
    value: "{{ description }}"
    description: |
      The description of the rule.
    default: 
  - name: enabled
    value: {{ enabled }}
    description: |
      When set to true, the rule is enabled.
    default: true
  - name: expression
    value: "{{ expression }}"
    description: |
      Criteria defining when there is a match for the current rule.

UPDATE examples

waiting_room_patch_waiting_room_rule

Patches a rule for a waiting room.

UPDATE cloudflare.waiting_rooms.rules
SET 
action = '{{ action }}',
description = '{{ description }}',
enabled = {{ enabled }},
expression = '{{ expression }}',
position = '{{ position }}'
WHERE 
rule_id = '{{ rule_id }}' --required
AND waiting_room_id = '{{ waiting_room_id }}' --required
AND zone_id = '{{ zone_id }}' --required
AND action = '{{ action }}' --required
AND expression = '{{ expression }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

REPLACE examples

waiting_room_replace_waiting_room_rules

Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.

REPLACE cloudflare.waiting_rooms.rules
SET 
-- No updatable properties
WHERE 
waiting_room_id = '{{ waiting_room_id }}' --required
AND zone_id = '{{ zone_id }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

DELETE examples

waiting_room_delete_waiting_room_rule

Deletes a rule for a waiting room.

DELETE FROM cloudflare.waiting_rooms.rules
WHERE rule_id = '{{ rule_id }}' --required
AND waiting_room_id = '{{ waiting_room_id }}' --required
AND zone_id = '{{ zone_id }}' --required
;