Cloudflare API | Waiting Rooms › List Waiting Rooms

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": [
    {
      "id": "699d98642c564d2e855e9661899b7252",
      "additional_routes": [
        {
          "host": "shop2.example.com",
          "path": "/shop2/checkout"
        }
      ],
      "cookie_attributes": {
        "samesite": "auto",
        "secure": "auto"
      },
      "cookie_suffix": "abcd",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}",
      "default_template_language": "en-US",
      "description": "Production - DO NOT MODIFY",
      "disable_session_renewal": false,
      "enabled_origin_commands": [
        "revoke"
      ],
      "host": "shop.example.com",
      "json_response_enabled": false,
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "name": "production_webinar",
      "new_users_per_minute": 200,
      "next_event_prequeue_start_time": "2021-09-28T15:00:00.000Z",
      "next_event_start_time": "2021-09-28T15:00:00.000Z",
      "path": "/shop/checkout",
      "queue_all": true,
      "queueing_method": "fifo",
      "queueing_status_code": 200,
      "session_duration": 1,
      "suspended": true,
      "total_active_users": 200
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Update Waiting Room -> Envelope<

WaitingRoom

put/zones/{zone_id}/waiting_rooms/{waiting_room_id}

Updates a configured waiting room.

Domain types

AdditionalRoutes = { host, path }

CookieAttributes = { samesite, secure }

Query = { host, name, new_users_per_minute, 16 more... }

WaitingRoom = { id, additional_routes, cookie_attributes, 21 more... }

Waiting Rooms

Events

waiting_rooms.events

Methods

Create Event -> Envelope<

Event

post/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events

Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.

Delete Event -> Envelope<{ id }>

delete/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}

Deletes an event for a waiting room.

Patch Event -> Envelope<

Event

patch/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}

Patches a configured event for a waiting room.

Event Details -> Envelope<

Event

get/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}

Fetches a single configured event for a waiting room.

List Events -> V4PagePaginationArray<

Event

get/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events

Lists events for a waiting room.

Update Event -> Envelope<

Event

put/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}

Updates a configured event for a waiting room.

Domain types

Event = { id, created_on, custom_page_html, 13 more... }

Waiting Rooms Events

Details

waiting_rooms.events.details

Methods

Preview Active Event Details -> Envelope<{ id, created_on, custom_page_html, 13 more... }>

get/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}/details

Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.

Domain types

EventQuery = { event_end_time, event_start_time, name, 10 more... }

Waiting Rooms

Page

waiting_rooms.page

Methods

Create A Custom Waiting Room Page Preview -> Envelope<{ preview_url }>

post/zones/{zone_id}/waiting_rooms/preview

Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form http://waitingrooms.dev/preview/<uuid>. You can use the following query parameters to change the state of the preview:

force_queue: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).
queue_is_full: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
queueing_method: The queueing method currently used by the waiting room.
- fifo indicates a FIFO queue.
- random indicates a Random queue.
- passthrough indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if force_queue=true or event=prequeueing — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning "Welcome".
- reject indicates a Reject queue.
event: Used to preview a waiting room event.
- none indicates no event is occurring.
- prequeueing indicates that an event is prequeueing (between prequeue_start_time and event_start_time).
- started indicates that an event has started (between event_start_time and event_end_time).
shuffle_at_event_start: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to true if an event is active (event is not none).

For example, you can make a request to http://waitingrooms.dev/preview/<uuid>?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true 6. waitTime: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.

For example, you can make a request to http://waitingrooms.dev/preview/<uuid>?waitTime=50 to configure the estimated wait time as 50 minutes.

Waiting Rooms

Rules

waiting_rooms.rules

Methods

Create Waiting Room Rule -> Envelope<Array<

WaitingRoomRule

post/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules

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

Delete Waiting Room Rule -> Envelope<Array<

WaitingRoomRule

delete/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}

Deletes a rule for a waiting room.

Patch Waiting Room Rule -> Envelope<Array<

WaitingRoomRule

patch/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}

Patches a rule for a waiting room.

List Waiting Room Rules -> Envelope<Array<

WaitingRoomRule

get/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules

Lists rules for a waiting room.

Replace Waiting Room Rules -> Envelope<Array<

WaitingRoomRule

put/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules

Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.

Domain types

WaitingRoomRule = { id, action, description, 4 more... }

Waiting Rooms

Settings

waiting_rooms.settings

Methods

Patch Zone Level Waiting Room Settings -> Envelope<{ search_engine_crawler_bypass }>

patch/zones/{zone_id}/waiting_rooms/settings

Patch zone-level Waiting Room settings

Get Zone Level Waiting Room Settings -> Envelope<{ search_engine_crawler_bypass }>

get/zones/{zone_id}/waiting_rooms/settings

Get zone-level Waiting Room settings

Update Zone Level Waiting Room Settings -> Envelope<{ search_engine_crawler_bypass }>

put/zones/{zone_id}/waiting_rooms/settings

Update zone-level Waiting Room settings

Domain types

Setting = { search_engine_crawler_bypass }

Waiting Rooms

Statuses

waiting_rooms.statuses

Methods

Get Waiting Room Status -> Envelope<{ estimated_queued_users, estimated_total_active_users, event_id, 2 more... }>

get/zones/{zone_id}/waiting_rooms/{waiting_room_id}/status

Fetches the status of a configured waiting room. Response fields include:

status: String indicating the status of the waiting room. The possible status are:
- not_queueing indicates that the configured thresholds have not been met and all users are going through to the origin.
- queueing indicates that the thresholds have been met and some users are held in the waiting room.
- event_prequeueing indicates that an event is active and is currently prequeueing users before it starts.
event_id: String of the current event's id if an event is active, otherwise an empty string.
estimated_queued_users: Integer of the estimated number of users currently waiting in the queue.
estimated_total_active_users: Integer of the estimated number of users currently active on the origin.
max_estimated_time_minutes: Integer of the maximum estimated time currently presented to the users.