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.
- suspended indicates that the room is suspended.
event_id
: String of the current event'sid
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.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
Name | Type | Required | Description |
---|---|---|---|
waiting_room_id |
String | Yes | |
zone_id |
String | Yes |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.