Create a waiting room

You can create a waiting room from the dashboard or via API.

Note

For additional context on creating a waiting room, refer to Get started.

Dashboard

1. Within your application, go to Traffic > Waiting Room.
2. Select Create.
3. Customize the settings for your waiting room. For additional guidance refer to Best practices.
4. Select Next.
5. In this section, you can choose whether to enable Turnstile for your waiting room. If you select Yes, you will need to choose your Widget mode and define the action to take if a turnstile challenge fails. The available Widget modes and actions depend on your plan type. Refer to the Plans for more details.
6. If you wish to customize your waiting room, update the HTML and CSS as needed. If you are using this waiting room to manage traffic for your mobile app or API, enable the JSON response toggle. Make sure that you have set up a JSON friendly response for your client (mobile or web app).
7. Select the Queuing status code to determine the HTTP status code that is returned when a user is in the waiting room.
8. Select Next.
9. Review your settings before saving. If you customized your waiting room, make sure to preview the result.
10. Select Save. Your new waiting room will be enabled by default.

API

To create a Waiting Room using the API, send a POST request to the /zones/{zone_identifier}/waiting_rooms endpoint:

• For parameter references, refer to Configuration settings
• For authentication instructions, refer to Create an API token.
• For help with endpoints and pagination, refer to Make API calls.

Request

curl -X POST "https://api.cloudflare.com/client/v4/zones/{zone_identifier}/waiting_rooms" \
--header 'Authorization: Bearer REDACTED' \
--header 'Content-Type: application/json' \
--data '{
  "name": "shop_waiting_room",
  "description": "Waiting room for webshop",
  "host": "shop.example.com",
  "path": "/shop",
  "queue_all": true,
  "new_users_per_minute": 200,
  "total_active_users": 300,
  "session_duration": 1,
  "disable_session_renewal": false,
  "json_response_enabled": false,
  "queueing_method": "fifo",
  "queueing_status_code": 202,
  "cookie_attributes": {
    "samesite": "auto",
    "secure": "auto"
  }
}'

The response contains the complete definition of the newly created Waiting Room.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "1111111111111111111111",
      "created_on": "2023-01-01T05:20:00.12345Z",
      "modified_on": "2023-01-01T05:20:00.12345Z",
      "name": "shop_waiting_room",
      "description": "Waiting room for webshop",
      "host": "shop.example.com",
      "path": "/shop",
      "queue_all": true,
      "new_users_per_minute": 200,
      "total_active_users": 300,
      "session_duration": 1,
      "disable_session_renewal": false,
      "json_response_enabled": false,
      "queueing_method": "fifo",
      "queueing_status_code": 202,
      "cookie_attributes": {
        "samesite": "auto",
        "secure": "auto"
      }
    }
  ]
}