Skip to content
Cloudflare API
Start here
API Reference
Waiting Rooms

Rules

List Waiting Room Rules
waiting_rooms.rules.get(strwaiting_room_id, RuleGetParams**kwargs) -> SyncSinglePage[WaitingRoomRule]
GET/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Create Waiting Room Rule
waiting_rooms.rules.create(strwaiting_room_id, RuleCreateParams**kwargs) -> SyncSinglePage[WaitingRoomRule]
POST/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Replace Waiting Room Rules
waiting_rooms.rules.update(strwaiting_room_id, RuleUpdateParams**kwargs) -> SyncSinglePage[WaitingRoomRule]
PUT/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules
Patch Waiting Room Rule
waiting_rooms.rules.edit(strrule_id, RuleEditParams**kwargs) -> SyncSinglePage[WaitingRoomRule]
PATCH/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
Delete Waiting Room Rule
waiting_rooms.rules.delete(strrule_id, RuleDeleteParams**kwargs) -> SyncSinglePage[WaitingRoomRule]
DELETE/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}
ModelsExpand Collapse
class WaitingRoomRule: …
id: Optional[str]

The ID of the rule.

action: Optional[Literal["bypass_waiting_room"]]

The action to take when the expression matches.

description: Optional[str]

The description of the rule.

enabled: Optional[bool]

When set to true, the rule is enabled.

expression: Optional[str]

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

last_updated: Optional[datetime]
formatdate-time
version: Optional[str]

The version of the rule.