Skip to content
Waiting Room
Visit Waiting Room on GitHub
Set theme to dark (⇧+D)

Using the Waiting Room API

Cloudflare Waiting Rooms redirect visitors to virtual waiting rooms when they are trying to access web pages that have high volumes of traffic.

The Cloudflare Waiting Room API provides an interface for programmatically managing waiting rooms.

Request URL format

To invoke a Cloudflare Waiting Room API operation, append the endpoint to the Cloudflare API base URL:

https://api.cloudflare.com/client/v4

For authentication instructions, see Getting Started: Requests in the Cloudflare API documentation.

For help with endpoints and pagination, see Getting Started: Endpoints.

Manage Your Waiting Rooms

OperationMethod + URL stubNotes
List Waiting RoomsGET zones/{:zone_identifier}/waiting_roomsList all waiting rooms for a zone.
Create Waiting RoomPOST zones/{:zone_identifier}/waiting_roomsCreate a waiting room.
Waiting Room DetailsGET zones/{:zone_identifier}/waiting_rooms/{:identifier}Fetch a waiting room.
Update Waiting RoomPUT zones/{:zone_identifier}/waiting_rooms/{:identifier}Update a waiting room.
Delete Waiting RoomDELETE zones/{:zone_identifier}/waiting_rooms/{:identifier}Delete a waiting room.
Patch Waiting RoomPATCH zones/{:zone_identifier}/waiting_rooms/{:identifier}Patch a configured waiting room.

Fetch the current status of a Waiting Room

OperationMethod + URL stubNotes
Get the current status of a waiting roomGET zones/{:zone_identifier}/waiting_rooms/{:identifier}/status
  • Returns queueing if the queue is activated (clients are put in the waiting room).
  • Returns not_queueing if the queue is not activated or if the waiting room is suspended.