Configure settings from the Cloudflare dashboard
To configure settings for a waiting room, select the Settings tab in the Create Waiting Room page.
The table below describes the Settings fields that you can configure in the dashboard, and indicates the equivalent Waiting Room API parameter for each setting.
Settings | Notes | ||
Dashboard Setting | API parameter | Required or optional | Description |
Name | name | Required | Unique waiting room name. |
Hostname | host | Required | Host name for which the waiting room will be applied (no wildcards).Do not include http:// or https://. |
Path | path | Optional | Specific path within the host where the waiting room will be applied. The waiting room will be enabled for all subpaths. Wildcards and query parameters are not supported. |
Total active users | total_active_users | Required | The maximum number of active sessions allowed in host/path at a given time. The maximum recommended value is 80% to 85% of the traffic capacity that your origin can handle. |
New users per minute | new_users_per_minute | Required | Amount of new users per minute that can be allowed into host/path : less than or equal to target concurrent users. |
Session duration | session_duration | Optional | The amount of time in minutes that a user who left host/path can come directly back without having to go into the Waiting Room. |
Description | description | Optional | Description of the Waiting Room. |
Next steps
Click Next or the Customization tab to modify the waiting room page design.