Skip to content
Cloudflare API
Start here
API Reference
Waiting Rooms

Rules

List Waiting Room Rules
client.waitingRooms.rules.get(stringwaitingRoomId, RuleGetParams { zone_id } params, RequestOptionsoptions?): SinglePage<WaitingRoomRule { id, action, description, 4 more } >
GET/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Create Waiting Room Rule
client.waitingRooms.rules.create(stringwaitingRoomId, RuleCreateParams { zone_id, rules } params, RequestOptionsoptions?): SinglePage<WaitingRoomRule { id, action, description, 4 more } >
POST/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Replace Waiting Room Rules
client.waitingRooms.rules.update(stringwaitingRoomId, RuleUpdateParams { zone_id, rules } params, RequestOptionsoptions?): SinglePage<WaitingRoomRule { id, action, description, 4 more } >
PUT/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Patch Waiting Room Rule
client.waitingRooms.rules.edit(stringwaitingRoomId, stringruleId, RuleEditParams { zone_id, action, expression, 3 more } params, RequestOptionsoptions?): SinglePage<WaitingRoomRule { id, action, description, 4 more } >
PATCH/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
Delete Waiting Room Rule
client.waitingRooms.rules.delete(stringwaitingRoomId, stringruleId, RuleDeleteParams { zone_id } params, RequestOptionsoptions?): SinglePage<WaitingRoomRule { id, action, description, 4 more } >
DELETE/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
ModelsExpand Collapse
WaitingRoomRule { id, action, description, 4 more }
id?: string

The ID of the rule.

action?: "bypass_waiting_room"

The action to take when the expression matches.

description?: string

The description of the rule.

enabled?: boolean

When set to true, the rule is enabled.

expression?: string

Criteria defining when there is a match for the current rule.

last_updated?: string
formatdate-time
version?: string

The version of the rule.