Create Waiting Room Rule

POST

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules

Last modified:2022-12-16 13:48:35

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

Request

Path Params

waiting_room_id

string

required

zone_identifier

string

required

Body Params application/json

action

enum<string>

required

The action to take when the expression matches.

Allowed value:

bypass_waiting_room

Example:

bypass_waiting_room

description

string

optional

The description of the rule.

Default:

Example:

allow all traffic from 10.20.30.40

enabled

boolean

optional

When set to true, the rule is enabled.

Default:

true

Example:

true

expression

string

required

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

Example:

ip.src in {10.20.30.40}

Example

{
    "action": "bypass_waiting_room",
    "description": "allow all traffic from 10.20.30.40",
    "enabled": true,
    "expression": "ip.src in {10.20.30.40}"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/zones//waiting_rooms//rules' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "bypass_waiting_room",
    "description": "allow all traffic from 10.20.30.40",
    "enabled": true,
    "expression": "ip.src in {10.20.30.40}"
}'

Responses

🟢200Create Waiting Room Rule response

application/json

Body

result

required

Any of

allOf {2}

array[object (rule_result) {7}]

allOf {2}

One of

array[object (rule_result) {7}]

object

action

enum<string>

rule_action

optional

The action to take when the expression matches.

Allowed value:

bypass_waiting_room

Example:

bypass_waiting_room

description

string

rule_description

optional

The description of the rule.

Default:

Example:

allow all traffic from 10.20.30.40

enabled

boolean

rule_enabled

optional

When set to true, the rule is enabled.

Default:

true

Example:

true

expression

string

rule_expression

optional

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

Example:

ip.src in {10.20.30.40}

string

rule_id

optional

The ID of the rule.

Example:

25756b2dfe6e378a06b033b670413757

last_updated

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

version

string

rule_version

optional

The version of the rule.

Example:

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "action": "bypass_waiting_room",
            "description": "allow all traffic from 10.20.30.40",
            "enabled": true,
            "expression": "ip.src in {10.20.30.40}",
            "id": "25756b2dfe6e378a06b033b670413757",
            "last_updated": "2014-01-01T05:20:00.12345Z",
            "version": "1"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

🟢200Create Waiting Room Rule response failure

Modified at 2022-12-16 13:48:35

List Waiting Room Rules

Replace Waiting Room Rules