--- title: Waiting Rooms --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Waiting Rooms ##### [List waiting rooms for account or zone](https://developers.cloudflare.com/api/go/resources/waiting_rooms/methods/list) client.WaitingRooms.List(ctx, params) (\*V4PagePaginationArray\[[WaitingRoom]()], error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/waiting\_rooms ##### [Waiting room details](https://developers.cloudflare.com/api/go/resources/waiting_rooms/methods/get) client.WaitingRooms.Get(ctx, waitingRoomID, query) (\*[WaitingRoom](), error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id} ##### [Create waiting room](https://developers.cloudflare.com/api/go/resources/waiting_rooms/methods/create) client.WaitingRooms.New(ctx, params) (\*[WaitingRoom](), error) POST/zones/{zone\_id}/waiting\_rooms ##### [Update waiting room](https://developers.cloudflare.com/api/go/resources/waiting_rooms/methods/update) client.WaitingRooms.Update(ctx, waitingRoomID, params) (\*[WaitingRoom](), error) PUT/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id} ##### [Patch waiting room](https://developers.cloudflare.com/api/go/resources/waiting_rooms/methods/edit) client.WaitingRooms.Edit(ctx, waitingRoomID, params) (\*[WaitingRoom](), error) PATCH/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id} ##### [Delete waiting room](https://developers.cloudflare.com/api/go/resources/waiting_rooms/methods/delete) client.WaitingRooms.Delete(ctx, waitingRoomID, body) (\*[WaitingRoomDeleteResponse](), error) DELETE/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id} ##### ModelsExpand Collapse

type AdditionalRoutes struct{…}

Host stringOptional The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://). Link to this property Path stringOptional Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. Link to this property

[Link to this property](<#(resource)%20waiting_rooms%20%3E%20(model)%20additional_routes%20%3E%20(schema)>)

type CookieAttributes struct{…} Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user’s status in the waiting room, such as queue position.

Samesite CookieAttributesSamesiteOptional Configures the SameSite attribute on the waiting room cookie. Value auto will be translated to lax or none depending if **Always Use HTTPS** is enabled. Note that when using value none, the secure attribute cannot be set to never.

One of the following: const CookieAttributesSamesiteAuto CookieAttributesSamesite = "auto" Link to this property const CookieAttributesSamesiteLax CookieAttributesSamesite = "lax" Link to this property const CookieAttributesSamesiteNone CookieAttributesSamesite = "none" Link to this property const CookieAttributesSamesiteStrict CookieAttributesSamesite = "strict" Link to this property

Link to this property

Secure CookieAttributesSecureOptional Configures the Secure attribute on the waiting room cookie. Value always indicates that the Secure attribute will be set in the Set-Cookie header, never indicates that the Secure attribute will not be set, and auto will set the Secure attribute depending if **Always Use HTTPS** is enabled.

One of the following: const CookieAttributesSecureAuto CookieAttributesSecure = "auto" Link to this property const CookieAttributesSecureAlways CookieAttributesSecure = "always" Link to this property const CookieAttributesSecureNever CookieAttributesSecure = "never" Link to this property

Link to this property

[Link to this property](<#(resource)%20waiting_rooms%20%3E%20(model)%20cookie_attributes%20%3E%20(schema)>)

type Query struct{…}

Host string The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. Link to this property Name string A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property NewUsersPerMinute int64 Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. maximum2147483647 minimum200 Link to this property TotalActiveUsers int64 Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. maximum2147483647 minimum200 Link to this property

AdditionalRoutes \[]AdditionalRoutesOptional Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.

Link to this property CookieAttributes CookieAttributesOptional Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user’s status in the waiting room, such as queue position. Link to this property CookieSuffix stringOptional Appends a ’\_’ + a custom suffix to the end of Cloudflare Waiting Room’s cookie name(\_\_cf\_waitingroom). If cookie_suffix is “abcd”, the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes. Link to this property CustomPageHTML stringOptional Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom\_page\_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: 1. {{waitTimeKnown}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue\_all is **true**. 2. {{waitTimeFormatted}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: 3. {{waitTime}} Number of minutes of estimated wait for a user. 4. {{waitTimeHours}} Number of hours of estimated wait for a user (Math.floor(waitTime/60)). 5. {{waitTimeHourMinutes}} Number of minutes above the waitTimeHours value (waitTime%60). 6. {{queueIsFull}} Changes to **true** when no more people can be added to the queue. To view the full list of variables, look at the cfWaitingRoom object described under the json_response_enabled property in other Waiting Room API calls. Link to this property

DefaultTemplateLanguage QueryDefaultTemplateLanguageOptional The language of the default page template. If no default\_template\_language is provided, then en-US (English) will be used.

One of the following: const QueryDefaultTemplateLanguageEnUs QueryDefaultTemplateLanguage = "en-US" Link to this property const QueryDefaultTemplateLanguageEsEs QueryDefaultTemplateLanguage = "es-ES" Link to this property const QueryDefaultTemplateLanguageDeDe QueryDefaultTemplateLanguage = "de-DE" Link to this property const QueryDefaultTemplateLanguageFrFr QueryDefaultTemplateLanguage = "fr-FR" Link to this property const QueryDefaultTemplateLanguageItIt QueryDefaultTemplateLanguage = "it-IT" Link to this property const QueryDefaultTemplateLanguageJaJp QueryDefaultTemplateLanguage = "ja-JP" Link to this property const QueryDefaultTemplateLanguageKoKr QueryDefaultTemplateLanguage = "ko-KR" Link to this property const QueryDefaultTemplateLanguagePtBr QueryDefaultTemplateLanguage = "pt-BR" Link to this property const QueryDefaultTemplateLanguageZhCn QueryDefaultTemplateLanguage = "zh-CN" Link to this property const QueryDefaultTemplateLanguageZhTw QueryDefaultTemplateLanguage = "zh-TW" Link to this property const QueryDefaultTemplateLanguageNlNl QueryDefaultTemplateLanguage = "nl-NL" Link to this property const QueryDefaultTemplateLanguagePlPl QueryDefaultTemplateLanguage = "pl-PL" Link to this property const QueryDefaultTemplateLanguageIDID QueryDefaultTemplateLanguage = "id-ID" Link to this property const QueryDefaultTemplateLanguageTrTr QueryDefaultTemplateLanguage = "tr-TR" Link to this property const QueryDefaultTemplateLanguageArEg QueryDefaultTemplateLanguage = "ar-EG" Link to this property const QueryDefaultTemplateLanguageRuRu QueryDefaultTemplateLanguage = "ru-RU" Link to this property const QueryDefaultTemplateLanguageFaIr QueryDefaultTemplateLanguage = "fa-IR" Link to this property const QueryDefaultTemplateLanguageBgBg QueryDefaultTemplateLanguage = "bg-BG" Link to this property const QueryDefaultTemplateLanguageHrHr QueryDefaultTemplateLanguage = "hr-HR" Link to this property const QueryDefaultTemplateLanguageCsCz QueryDefaultTemplateLanguage = "cs-CZ" Link to this property const QueryDefaultTemplateLanguageDaDK QueryDefaultTemplateLanguage = "da-DK" Link to this property const QueryDefaultTemplateLanguageFiFi QueryDefaultTemplateLanguage = "fi-FI" Link to this property const QueryDefaultTemplateLanguageLtLt QueryDefaultTemplateLanguage = "lt-LT" Link to this property const QueryDefaultTemplateLanguageLvLv QueryDefaultTemplateLanguage = "lv-LV" Link to this property const QueryDefaultTemplateLanguageMsMy QueryDefaultTemplateLanguage = "ms-MY" Link to this property const QueryDefaultTemplateLanguageNbNo QueryDefaultTemplateLanguage = "nb-NO" Link to this property const QueryDefaultTemplateLanguageRoRo QueryDefaultTemplateLanguage = "ro-RO" Link to this property const QueryDefaultTemplateLanguageElGr QueryDefaultTemplateLanguage = "el-GR" Link to this property const QueryDefaultTemplateLanguageHeIl QueryDefaultTemplateLanguage = "he-IL" Link to this property const QueryDefaultTemplateLanguageHiIn QueryDefaultTemplateLanguage = "hi-IN" Link to this property const QueryDefaultTemplateLanguageHuHu QueryDefaultTemplateLanguage = "hu-HU" Link to this property const QueryDefaultTemplateLanguageSrBa QueryDefaultTemplateLanguage = "sr-BA" Link to this property const QueryDefaultTemplateLanguageSkSk QueryDefaultTemplateLanguage = "sk-SK" Link to this property const QueryDefaultTemplateLanguageSlSi QueryDefaultTemplateLanguage = "sl-SI" Link to this property const QueryDefaultTemplateLanguageSvSe QueryDefaultTemplateLanguage = "sv-SE" Link to this property const QueryDefaultTemplateLanguageTlPh QueryDefaultTemplateLanguage = "tl-PH" Link to this property const QueryDefaultTemplateLanguageThTh QueryDefaultTemplateLanguage = "th-TH" Link to this property const QueryDefaultTemplateLanguageUkUA QueryDefaultTemplateLanguage = "uk-UA" Link to this property const QueryDefaultTemplateLanguageViVn QueryDefaultTemplateLanguage = "vi-VN" Link to this property

Link to this property Description stringOptional A note that you can use to add more details about the waiting room. Link to this property DisableSessionRenewal boolOptional Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If true, an accepted user will have session\_duration minutes to browse the site. After that, they will have to go through the waiting room again. If false, a user’s session cookie will be automatically renewed on every request. Link to this property EnabledOriginCommands \[]QueryEnabledOriginCommandOptional A list of enabled origin commands. Link to this property JsonResponseEnabled boolOptional Only available for the Waiting Room Advanced subscription. If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object with information on the user’s status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property cfWaitingRoom which is an object containing the following fields: 1. inWaitingRoom: Boolean indicating if the user is in the waiting room (always **true**). 2. waitTimeKnown: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available. 3. waitTime: Valid only when waitTimeKnown is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When queueingMethod is **random**, this is set to waitTime50Percentile. 4. waitTime25Percentile: Valid only when queueingMethod is **random** and waitTimeKnown is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile). 5. waitTime50Percentile: Valid only when queueingMethod is **random** and waitTimeKnown is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before waitTime50Percentile and half are expected to be let in after it. 6. waitTime75Percentile: Valid only when queueingMethod is **random** and waitTimeKnown is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile). 7. waitTimeFormatted: String displaying the waitTime formatted in English for users. If waitTimeKnown is **false**, waitTimeFormatted will display **unavailable**. 8. queueIsFull: Boolean indicating if the waiting room’s queue is currently full and not accepting new users at the moment. 9. queueAll: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website. 10. lastUpdated: String displaying the timestamp as an ISO 8601 string of the user’s last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after refreshIntervalSeconds past this time. If the user makes a request too soon, it will be ignored and lastUpdated will not change. 11. refreshIntervalSeconds: Integer indicating the number of seconds after lastUpdated until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the queueingMethod is reject, there is no specified refresh time —\_it will always be **zero**. 12. queueingMethod: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**. 13. isFIFOQueue: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue. 14. isRandomQueue: Boolean indicating if the waiting room uses a Random queue where users gain access randomly. 15. isPassthroughQueue: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when queueAll is **true** or isEventPrequeueing is **true** because in all other cases requests will go directly to the origin. 16. isRejectQueue: Boolean indicating if the waiting room uses a reject queue. 17. isEventActive: Boolean indicating if an event is currently occurring. Events are able to change a waiting room’s behavior during a specified period of time. For additional information, look at the event properties prequeue_start_time, event_start_time, and event_end_time in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists. 18. isEventPrequeueing: Valid only when isEventActive is **true**. Boolean indicating if an event is currently prequeueing users before it starts. 19. timeUntilEventStart: Valid only when isEventPrequeueing is **true**. Integer indicating the number of minutes until the event starts. 20. timeUntilEventStartFormatted: String displaying the timeUntilEventStart formatted in English for users. If isEventPrequeueing is **false**, timeUntilEventStartFormatted will display **unavailable**. 21. timeUntilEventEnd: Valid only when isEventActive is **true**. Integer indicating the number of minutes until the event ends. 22. timeUntilEventEndFormatted: String displaying the timeUntilEventEnd formatted in English for users. If isEventActive is **false**, timeUntilEventEndFormatted will display **unavailable**. 23. shuffleAtEventStart: Valid only when isEventActive is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts. 24. turnstile: Empty when turnstile isn’t enabled. String displaying an html tag to display the Turnstile widget. Please add the {{{turnstile}}} tag to the custom_html template to ensure the Turnstile widget appears. 25. infiniteQueue: Boolean indicating whether the response is for a user in the infinite queue. An example cURL to a waiting room could be: ```plaintext curl -X GET "https://example.com/waitingroom" \ -H "Accept: application/json" ``` If json_response_enabled is **true** and the request hits the waiting room, an example JSON response when queueingMethod is **fifo** and no event is active could be: ```plaintext { "cfWaitingRoom": { "inWaitingRoom": true, "waitTimeKnown": true, "waitTime": 10, "waitTime25Percentile": 0, "waitTime50Percentile": 0, "waitTime75Percentile": 0, "waitTimeFormatted": "10 minutes", "queueIsFull": false, "queueAll": false, "lastUpdated": "2020-08-03T23:46:00.000Z", "refreshIntervalSeconds": 20, "queueingMethod": "fifo", "isFIFOQueue": true, "isRandomQueue": false, "isPassthroughQueue": false, "isRejectQueue": false, "isEventActive": false, "isEventPrequeueing": false, "timeUntilEventStart": 0, "timeUntilEventStartFormatted": "unavailable", "timeUntilEventEnd": 0, "timeUntilEventEndFormatted": "unavailable", "shuffleAtEventStart": false } } ``` If json_response_enabled is **true** and the request hits the waiting room, an example JSON response when queueingMethod is **random** and an event is active could be: ```plaintext { "cfWaitingRoom": { "inWaitingRoom": true, "waitTimeKnown": true, "waitTime": 10, "waitTime25Percentile": 5, "waitTime50Percentile": 10, "waitTime75Percentile": 15, "waitTimeFormatted": "5 minutes to 15 minutes", "queueIsFull": false, "queueAll": false, "lastUpdated": "2020-08-03T23:46:00.000Z", "refreshIntervalSeconds": 20, "queueingMethod": "random", "isFIFOQueue": false, "isRandomQueue": true, "isPassthroughQueue": false, "isRejectQueue": false, "isEventActive": true, "isEventPrequeueing": false, "timeUntilEventStart": 0, "timeUntilEventStartFormatted": "unavailable", "timeUntilEventEnd": 15, "timeUntilEventEndFormatted": "15 minutes", "shuffleAtEventStart": true } } ``` Link to this property Path stringOptional Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. Link to this property QueueAll boolOptional If queue\_all is true, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. Link to this property

QueueingMethod QueryQueueingMethodOptional Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if queue_all is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: 1. fifo **(default)**: First-In-First-Out queue where customers gain access in the order they arrived. 2. random: Random queue where customers gain access randomly, regardless of arrival time. 3. passthrough: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with suspended) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa. 4. reject: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses reject, and its events override this with fifo, random, or passthrough. When this queueing method is enabled and neither queueAll is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.

One of the following: const QueryQueueingMethodFifo QueryQueueingMethod = "fifo" Link to this property const QueryQueueingMethodRandom QueryQueueingMethod = "random" Link to this property const QueryQueueingMethodPassthrough QueryQueueingMethod = "passthrough" Link to this property const QueryQueueingMethodReject QueryQueueingMethod = "reject" Link to this property

Link to this property

QueueingStatusCode QueryQueueingStatusCodeOptional HTTP status code returned to a user while in the queue.

One of the following: const QueryQueueingStatusCode200 QueryQueueingStatusCode = 200 Link to this property const QueryQueueingStatusCode202 QueryQueueingStatusCode = 202 Link to this property const QueryQueueingStatusCode429 QueryQueueingStatusCode = 429 Link to this property

TurnstileAction QueryTurnstileActionOptional Which action to take when a bot is detected using Turnstile. log will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. infinite_queue will send bots to a false queueing state, where they will never reach your origin. infinite_queue requires Advanced Waiting Room.

One of the following: const QueryTurnstileActionLog QueryTurnstileAction = "log" Link to this property const QueryTurnstileActionInfiniteQueue QueryTurnstileAction = "infinite\_queue" Link to this property

Link to this property

TurnstileMode QueryTurnstileModeOptional Which Turnstile widget type to use for detecting bot traffic. See the Turnstile documentation for the definitions of these widget types. Set to off to disable the Turnstile integration entirely. Setting this to anything other than off or invisible requires Advanced Waiting Room.

One of the following: const QueryTurnstileModeOff QueryTurnstileMode = "off" Link to this property const QueryTurnstileModeInvisible QueryTurnstileMode = "invisible" Link to this property const QueryTurnstileModeVisibleNonInteractive QueryTurnstileMode = "visible\_non\_interactive" Link to this property const QueryTurnstileModeVisibleManaged QueryTurnstileMode = "visible\_managed" Link to this property

Link to this property

[Link to this property](<#(resource)%20waiting_rooms%20%3E%20(model)%20query%20%3E%20(schema)>)

type WaitingRoom struct{…}

ID stringOptional Link to this property

Link to this property CookieAttributes CookieAttributesOptional Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user’s status in the waiting room, such as queue position. Link to this property CookieSuffix stringOptional Appends a ’\_’ + a custom suffix to the end of Cloudflare Waiting Room’s cookie name(\_\_cf\_waitingroom). If cookie_suffix is “abcd”, the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes. Link to this property CreatedOn TimeOptional formatdate-time Link to this property CustomPageHTML stringOptional Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom\_page\_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: 1. {{waitTimeKnown}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue\_all is **true**. 2. {{waitTimeFormatted}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: 3. {{waitTime}} Number of minutes of estimated wait for a user. 4. {{waitTimeHours}} Number of hours of estimated wait for a user (Math.floor(waitTime/60)). 5. {{waitTimeHourMinutes}} Number of minutes above the waitTimeHours value (waitTime%60). 6. {{queueIsFull}} Changes to **true** when no more people can be added to the queue. To view the full list of variables, look at the cfWaitingRoom object described under the json_response_enabled property in other Waiting Room API calls. Link to this property

DefaultTemplateLanguage WaitingRoomDefaultTemplateLanguageOptional The language of the default page template. If no default\_template\_language is provided, then en-US (English) will be used.

One of the following: const WaitingRoomDefaultTemplateLanguageEnUs WaitingRoomDefaultTemplateLanguage = "en-US" Link to this property const WaitingRoomDefaultTemplateLanguageEsEs WaitingRoomDefaultTemplateLanguage = "es-ES" Link to this property const WaitingRoomDefaultTemplateLanguageDeDe WaitingRoomDefaultTemplateLanguage = "de-DE" Link to this property const WaitingRoomDefaultTemplateLanguageFrFr WaitingRoomDefaultTemplateLanguage = "fr-FR" Link to this property const WaitingRoomDefaultTemplateLanguageItIt WaitingRoomDefaultTemplateLanguage = "it-IT" Link to this property const WaitingRoomDefaultTemplateLanguageJaJp WaitingRoomDefaultTemplateLanguage = "ja-JP" Link to this property const WaitingRoomDefaultTemplateLanguageKoKr WaitingRoomDefaultTemplateLanguage = "ko-KR" Link to this property const WaitingRoomDefaultTemplateLanguagePtBr WaitingRoomDefaultTemplateLanguage = "pt-BR" Link to this property const WaitingRoomDefaultTemplateLanguageZhCn WaitingRoomDefaultTemplateLanguage = "zh-CN" Link to this property const WaitingRoomDefaultTemplateLanguageZhTw WaitingRoomDefaultTemplateLanguage = "zh-TW" Link to this property const WaitingRoomDefaultTemplateLanguageNlNl WaitingRoomDefaultTemplateLanguage = "nl-NL" Link to this property const WaitingRoomDefaultTemplateLanguagePlPl WaitingRoomDefaultTemplateLanguage = "pl-PL" Link to this property const WaitingRoomDefaultTemplateLanguageIDID WaitingRoomDefaultTemplateLanguage = "id-ID" Link to this property const WaitingRoomDefaultTemplateLanguageTrTr WaitingRoomDefaultTemplateLanguage = "tr-TR" Link to this property const WaitingRoomDefaultTemplateLanguageArEg WaitingRoomDefaultTemplateLanguage = "ar-EG" Link to this property const WaitingRoomDefaultTemplateLanguageRuRu WaitingRoomDefaultTemplateLanguage = "ru-RU" Link to this property const WaitingRoomDefaultTemplateLanguageFaIr WaitingRoomDefaultTemplateLanguage = "fa-IR" Link to this property const WaitingRoomDefaultTemplateLanguageBgBg WaitingRoomDefaultTemplateLanguage = "bg-BG" Link to this property const WaitingRoomDefaultTemplateLanguageHrHr WaitingRoomDefaultTemplateLanguage = "hr-HR" Link to this property const WaitingRoomDefaultTemplateLanguageCsCz WaitingRoomDefaultTemplateLanguage = "cs-CZ" Link to this property const WaitingRoomDefaultTemplateLanguageDaDK WaitingRoomDefaultTemplateLanguage = "da-DK" Link to this property const WaitingRoomDefaultTemplateLanguageFiFi WaitingRoomDefaultTemplateLanguage = "fi-FI" Link to this property const WaitingRoomDefaultTemplateLanguageLtLt WaitingRoomDefaultTemplateLanguage = "lt-LT" Link to this property const WaitingRoomDefaultTemplateLanguageLvLv WaitingRoomDefaultTemplateLanguage = "lv-LV" Link to this property const WaitingRoomDefaultTemplateLanguageMsMy WaitingRoomDefaultTemplateLanguage = "ms-MY" Link to this property const WaitingRoomDefaultTemplateLanguageNbNo WaitingRoomDefaultTemplateLanguage = "nb-NO" Link to this property const WaitingRoomDefaultTemplateLanguageRoRo WaitingRoomDefaultTemplateLanguage = "ro-RO" Link to this property const WaitingRoomDefaultTemplateLanguageElGr WaitingRoomDefaultTemplateLanguage = "el-GR" Link to this property const WaitingRoomDefaultTemplateLanguageHeIl WaitingRoomDefaultTemplateLanguage = "he-IL" Link to this property const WaitingRoomDefaultTemplateLanguageHiIn WaitingRoomDefaultTemplateLanguage = "hi-IN" Link to this property const WaitingRoomDefaultTemplateLanguageHuHu WaitingRoomDefaultTemplateLanguage = "hu-HU" Link to this property const WaitingRoomDefaultTemplateLanguageSrBa WaitingRoomDefaultTemplateLanguage = "sr-BA" Link to this property const WaitingRoomDefaultTemplateLanguageSkSk WaitingRoomDefaultTemplateLanguage = "sk-SK" Link to this property const WaitingRoomDefaultTemplateLanguageSlSi WaitingRoomDefaultTemplateLanguage = "sl-SI" Link to this property const WaitingRoomDefaultTemplateLanguageSvSe WaitingRoomDefaultTemplateLanguage = "sv-SE" Link to this property const WaitingRoomDefaultTemplateLanguageTlPh WaitingRoomDefaultTemplateLanguage = "tl-PH" Link to this property const WaitingRoomDefaultTemplateLanguageThTh WaitingRoomDefaultTemplateLanguage = "th-TH" Link to this property const WaitingRoomDefaultTemplateLanguageUkUA WaitingRoomDefaultTemplateLanguage = "uk-UA" Link to this property const WaitingRoomDefaultTemplateLanguageViVn WaitingRoomDefaultTemplateLanguage = "vi-VN" Link to this property

Link to this property Description stringOptional A note that you can use to add more details about the waiting room. Link to this property DisableSessionRenewal boolOptional Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If true, an accepted user will have session\_duration minutes to browse the site. After that, they will have to go through the waiting room again. If false, a user’s session cookie will be automatically renewed on every request. Link to this property EnabledOriginCommands \[]WaitingRoomEnabledOriginCommandOptional A list of enabled origin commands. Link to this property Host stringOptional The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. Link to this property JsonResponseEnabled boolOptional Only available for the Waiting Room Advanced subscription. If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object with information on the user’s status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property cfWaitingRoom which is an object containing the following fields: 1. inWaitingRoom: Boolean indicating if the user is in the waiting room (always **true**). 2. waitTimeKnown: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available. 3. waitTime: Valid only when waitTimeKnown is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When queueingMethod is **random**, this is set to waitTime50Percentile. 4. waitTime25Percentile: Valid only when queueingMethod is **random** and waitTimeKnown is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile). 5. waitTime50Percentile: Valid only when queueingMethod is **random** and waitTimeKnown is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before waitTime50Percentile and half are expected to be let in after it. 6. waitTime75Percentile: Valid only when queueingMethod is **random** and waitTimeKnown is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile). 7. waitTimeFormatted: String displaying the waitTime formatted in English for users. If waitTimeKnown is **false**, waitTimeFormatted will display **unavailable**. 8. queueIsFull: Boolean indicating if the waiting room’s queue is currently full and not accepting new users at the moment. 9. queueAll: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website. 10. lastUpdated: String displaying the timestamp as an ISO 8601 string of the user’s last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after refreshIntervalSeconds past this time. If the user makes a request too soon, it will be ignored and lastUpdated will not change. 11. refreshIntervalSeconds: Integer indicating the number of seconds after lastUpdated until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the queueingMethod is reject, there is no specified refresh time —\_it will always be **zero**. 12. queueingMethod: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**. 13. isFIFOQueue: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue. 14. isRandomQueue: Boolean indicating if the waiting room uses a Random queue where users gain access randomly. 15. isPassthroughQueue: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when queueAll is **true** or isEventPrequeueing is **true** because in all other cases requests will go directly to the origin. 16. isRejectQueue: Boolean indicating if the waiting room uses a reject queue. 17. isEventActive: Boolean indicating if an event is currently occurring. Events are able to change a waiting room’s behavior during a specified period of time. For additional information, look at the event properties prequeue_start_time, event_start_time, and event_end_time in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists. 18. isEventPrequeueing: Valid only when isEventActive is **true**. Boolean indicating if an event is currently prequeueing users before it starts. 19. timeUntilEventStart: Valid only when isEventPrequeueing is **true**. Integer indicating the number of minutes until the event starts. 20. timeUntilEventStartFormatted: String displaying the timeUntilEventStart formatted in English for users. If isEventPrequeueing is **false**, timeUntilEventStartFormatted will display **unavailable**. 21. timeUntilEventEnd: Valid only when isEventActive is **true**. Integer indicating the number of minutes until the event ends. 22. timeUntilEventEndFormatted: String displaying the timeUntilEventEnd formatted in English for users. If isEventActive is **false**, timeUntilEventEndFormatted will display **unavailable**. 23. shuffleAtEventStart: Valid only when isEventActive is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts. 24. turnstile: Empty when turnstile isn’t enabled. String displaying an html tag to display the Turnstile widget. Please add the {{{turnstile}}} tag to the custom_html template to ensure the Turnstile widget appears. 25. infiniteQueue: Boolean indicating whether the response is for a user in the infinite queue. An example cURL to a waiting room could be: ```plaintext curl -X GET "https://example.com/waitingroom" \ -H "Accept: application/json" ``` If json_response_enabled is **true** and the request hits the waiting room, an example JSON response when queueingMethod is **fifo** and no event is active could be: ```plaintext { "cfWaitingRoom": { "inWaitingRoom": true, "waitTimeKnown": true, "waitTime": 10, "waitTime25Percentile": 0, "waitTime50Percentile": 0, "waitTime75Percentile": 0, "waitTimeFormatted": "10 minutes", "queueIsFull": false, "queueAll": false, "lastUpdated": "2020-08-03T23:46:00.000Z", "refreshIntervalSeconds": 20, "queueingMethod": "fifo", "isFIFOQueue": true, "isRandomQueue": false, "isPassthroughQueue": false, "isRejectQueue": false, "isEventActive": false, "isEventPrequeueing": false, "timeUntilEventStart": 0, "timeUntilEventStartFormatted": "unavailable", "timeUntilEventEnd": 0, "timeUntilEventEndFormatted": "unavailable", "shuffleAtEventStart": false } } ``` If json_response_enabled is **true** and the request hits the waiting room, an example JSON response when queueingMethod is **random** and an event is active could be: ```plaintext { "cfWaitingRoom": { "inWaitingRoom": true, "waitTimeKnown": true, "waitTime": 10, "waitTime25Percentile": 5, "waitTime50Percentile": 10, "waitTime75Percentile": 15, "waitTimeFormatted": "5 minutes to 15 minutes", "queueIsFull": false, "queueAll": false, "lastUpdated": "2020-08-03T23:46:00.000Z", "refreshIntervalSeconds": 20, "queueingMethod": "random", "isFIFOQueue": false, "isRandomQueue": true, "isPassthroughQueue": false, "isRejectQueue": false, "isEventActive": true, "isEventPrequeueing": false, "timeUntilEventStart": 0, "timeUntilEventStartFormatted": "unavailable", "timeUntilEventEnd": 15, "timeUntilEventEndFormatted": "15 minutes", "shuffleAtEventStart": true } } ``` Link to this property ModifiedOn TimeOptional formatdate-time Link to this property Name stringOptional A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property NewUsersPerMinute int64Optional Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. maximum2147483647 minimum200 Link to this property NextEventPrequeueStartTime stringOptional An ISO 8601 timestamp that marks when the next event will begin queueing. Link to this property NextEventStartTime stringOptional An ISO 8601 timestamp that marks when the next event will start. Link to this property Path stringOptional Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. Link to this property QueueAll boolOptional If queue\_all is true, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. Link to this property

QueueingMethod WaitingRoomQueueingMethodOptional Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if queue_all is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: 1. fifo **(default)**: First-In-First-Out queue where customers gain access in the order they arrived. 2. random: Random queue where customers gain access randomly, regardless of arrival time. 3. passthrough: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with suspended) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa. 4. reject: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses reject, and its events override this with fifo, random, or passthrough. When this queueing method is enabled and neither queueAll is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.

One of the following: const WaitingRoomQueueingMethodFifo WaitingRoomQueueingMethod = "fifo" Link to this property const WaitingRoomQueueingMethodRandom WaitingRoomQueueingMethod = "random" Link to this property const WaitingRoomQueueingMethodPassthrough WaitingRoomQueueingMethod = "passthrough" Link to this property const WaitingRoomQueueingMethodReject WaitingRoomQueueingMethod = "reject" Link to this property

Link to this property

QueueingStatusCode WaitingRoomQueueingStatusCodeOptional HTTP status code returned to a user while in the queue.

One of the following: const WaitingRoomQueueingStatusCode200 WaitingRoomQueueingStatusCode = 200 Link to this property const WaitingRoomQueueingStatusCode202 WaitingRoomQueueingStatusCode = 202 Link to this property const WaitingRoomQueueingStatusCode429 WaitingRoomQueueingStatusCode = 429 Link to this property

Link to this property SessionDuration int64Optional Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. maximum30 minimum1 Link to this property Suspended boolOptional Suspends or allows traffic going to the waiting room. If set to true, the traffic will not go to the waiting room. Link to this property TotalActiveUsers int64Optional Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. maximum2147483647 minimum200 Link to this property

TurnstileAction WaitingRoomTurnstileActionOptional Which action to take when a bot is detected using Turnstile. log will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. infinite_queue will send bots to a false queueing state, where they will never reach your origin. infinite_queue requires Advanced Waiting Room.

One of the following: const WaitingRoomTurnstileActionLog WaitingRoomTurnstileAction = "log" Link to this property const WaitingRoomTurnstileActionInfiniteQueue WaitingRoomTurnstileAction = "infinite\_queue" Link to this property

Link to this property

TurnstileMode WaitingRoomTurnstileModeOptional Which Turnstile widget type to use for detecting bot traffic. See the Turnstile documentation for the definitions of these widget types. Set to off to disable the Turnstile integration entirely. Setting this to anything other than off or invisible requires Advanced Waiting Room.

One of the following: const WaitingRoomTurnstileModeOff WaitingRoomTurnstileMode = "off" Link to this property const WaitingRoomTurnstileModeInvisible WaitingRoomTurnstileMode = "invisible" Link to this property const WaitingRoomTurnstileModeVisibleNonInteractive WaitingRoomTurnstileMode = "visible\_non\_interactive" Link to this property const WaitingRoomTurnstileModeVisibleManaged WaitingRoomTurnstileMode = "visible\_managed" Link to this property

Link to this property

[Link to this property](<#(resource)%20waiting_rooms%20%3E%20(model)%20waiting_room%20%3E%20(schema)>) #### Waiting RoomsPage ##### [Create a custom waiting room page preview](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/page/methods/preview) client.WaitingRooms.Page.Preview(ctx, params) (\*[PagePreviewResponse](), error) POST/zones/{zone\_id}/waiting\_rooms/preview #### Waiting RoomsEvents ##### [List events](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/list) client.WaitingRooms.Events.List(ctx, waitingRoomID, params) (\*V4PagePaginationArray\[[Event]()], error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events ##### [Event details](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/get) client.WaitingRooms.Events.Get(ctx, waitingRoomID, eventID, query) (\*[Event](), error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Create event](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/create) client.WaitingRooms.Events.New(ctx, waitingRoomID, params) (\*[Event](), error) POST/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events ##### [Update event](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/update) client.WaitingRooms.Events.Update(ctx, waitingRoomID, eventID, params) (\*[Event](), error) PUT/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Patch event](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/edit) client.WaitingRooms.Events.Edit(ctx, waitingRoomID, eventID, params) (\*[Event](), error) PATCH/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### [Delete event](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/methods/delete) client.WaitingRooms.Events.Delete(ctx, waitingRoomID, eventID, body) (\*[EventDeleteResponse](), error) DELETE/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id} ##### ModelsExpand Collapse

type Event struct{…}

ID stringOptional Link to this property CreatedOn TimeOptional formatdate-time Link to this property CustomPageHTML stringOptional If set, the event will override the waiting room’s custom_page_html property while it is active. If null, the event will inherit it. Link to this property Description stringOptional A note that you can use to add more details about the event. Link to this property DisableSessionRenewal boolOptional If set, the event will override the waiting room’s disable_session_renewal property while it is active. If null, the event will inherit it. Link to this property EventEndTime stringOptional An ISO 8601 timestamp that marks the end of the event. Link to this property EventStartTime stringOptional An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event’s configuration. The start time must be at least one minute before event_end_time. Link to this property ModifiedOn TimeOptional formatdate-time Link to this property Name stringOptional A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property NewUsersPerMinute int64Optional If set, the event will override the waiting room’s new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event’s total_active_users property is also set. maximum2147483647 minimum200 Link to this property PrequeueStartTime stringOptional An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before event_start_time. Link to this property QueueingMethod stringOptional If set, the event will override the waiting room’s queueing_method property while it is active. If null, the event will inherit it. Link to this property SessionDuration int64Optional If set, the event will override the waiting room’s session_duration property while it is active. If null, the event will inherit it. maximum30 minimum1 Link to this property ShuffleAtEventStart boolOptional If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. Link to this property Suspended boolOptional Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration. Link to this property TotalActiveUsers int64Optional If set, the event will override the waiting room’s total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event’s new_users_per_minute property is also set. maximum2147483647 minimum200 Link to this property

TurnstileAction EventTurnstileActionOptional If set, the event will override the waiting room’s turnstile_action property while it is active. If null, the event will inherit it.

One of the following: const EventTurnstileActionLog EventTurnstileAction = "log" Link to this property const EventTurnstileActionInfiniteQueue EventTurnstileAction = "infinite\_queue" Link to this property

Link to this property

TurnstileMode EventTurnstileModeOptional If set, the event will override the waiting room’s turnstile_mode property while it is active. If null, the event will inherit it.

One of the following: const EventTurnstileModeOff EventTurnstileMode = "off" Link to this property const EventTurnstileModeInvisible EventTurnstileMode = "invisible" Link to this property const EventTurnstileModeVisibleNonInteractive EventTurnstileMode = "visible\_non\_interactive" Link to this property const EventTurnstileModeVisibleManaged EventTurnstileMode = "visible\_managed" Link to this property

Link to this property

[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(model)%20event%20%3E%20(schema)>) #### Waiting RoomsEventsDetails ##### [Preview active event details](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/events/subresources/details/methods/get) client.WaitingRooms.Events.Details.Get(ctx, waitingRoomID, eventID, query) (\*[EventDetailGetResponse](), error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events/{event\_id}/details ##### ModelsExpand Collapse

type EventQuery struct{…}

EventEndTime string An ISO 8601 timestamp that marks the end of the event. Link to this property EventStartTime string An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event’s configuration. The start time must be at least one minute before event_end_time. Link to this property Name string A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property CustomPageHTML stringOptional If set, the event will override the waiting room’s custom_page_html property while it is active. If null, the event will inherit it. Link to this property Description stringOptional A note that you can use to add more details about the event. Link to this property DisableSessionRenewal boolOptional If set, the event will override the waiting room’s disable_session_renewal property while it is active. If null, the event will inherit it. Link to this property NewUsersPerMinute int64Optional If set, the event will override the waiting room’s new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event’s total_active_users property is also set. maximum2147483647 minimum200 Link to this property PrequeueStartTime stringOptional An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before event_start_time. Link to this property QueueingMethod stringOptional If set, the event will override the waiting room’s queueing_method property while it is active. If null, the event will inherit it. Link to this property SessionDuration int64Optional If set, the event will override the waiting room’s session_duration property while it is active. If null, the event will inherit it. maximum30 minimum1 Link to this property ShuffleAtEventStart boolOptional If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. Link to this property Suspended boolOptional Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration. Link to this property TotalActiveUsers int64Optional If set, the event will override the waiting room’s total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event’s new_users_per_minute property is also set. maximum2147483647 minimum200 Link to this property

TurnstileAction EventQueryTurnstileActionOptional If set, the event will override the waiting room’s turnstile_action property while it is active. If null, the event will inherit it.

One of the following: const EventQueryTurnstileActionLog EventQueryTurnstileAction = "log" Link to this property const EventQueryTurnstileActionInfiniteQueue EventQueryTurnstileAction = "infinite\_queue" Link to this property

Link to this property

TurnstileMode EventQueryTurnstileModeOptional If set, the event will override the waiting room’s turnstile_mode property while it is active. If null, the event will inherit it.

One of the following: const EventQueryTurnstileModeOff EventQueryTurnstileMode = "off" Link to this property const EventQueryTurnstileModeInvisible EventQueryTurnstileMode = "invisible" Link to this property const EventQueryTurnstileModeVisibleNonInteractive EventQueryTurnstileMode = "visible\_non\_interactive" Link to this property const EventQueryTurnstileModeVisibleManaged EventQueryTurnstileMode = "visible\_managed" Link to this property

Link to this property

[Link to this property](<#(resource)%20waiting_rooms.events.details%20%3E%20(model)%20event_query%20%3E%20(schema)>) #### Waiting RoomsRules ##### [List Waiting Room Rules](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/rules/methods/get) client.WaitingRooms.Rules.Get(ctx, waitingRoomID, query) (\*SinglePage\[[WaitingRoomRule]()], error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/rules ##### [Create Waiting Room Rule](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/rules/methods/create) client.WaitingRooms.Rules.New(ctx, waitingRoomID, params) (\*SinglePage\[[WaitingRoomRule]()], error) POST/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/rules ##### [Replace Waiting Room Rules](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/rules/methods/update) client.WaitingRooms.Rules.Update(ctx, waitingRoomID, params) (\*SinglePage\[[WaitingRoomRule]()], error) PUT/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/rules ##### [Patch Waiting Room Rule](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/rules/methods/edit) client.WaitingRooms.Rules.Edit(ctx, waitingRoomID, ruleID, params) (\*SinglePage\[[WaitingRoomRule]()], error) PATCH/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/rules/{rule\_id} ##### [Delete Waiting Room Rule](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/rules/methods/delete) client.WaitingRooms.Rules.Delete(ctx, waitingRoomID, ruleID, body) (\*SinglePage\[[WaitingRoomRule]()], error) DELETE/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/rules/{rule\_id} ##### ModelsExpand Collapse

type WaitingRoomRule struct{…}

ID stringOptional The ID of the rule. Link to this property Action WaitingRoomRuleActionOptional The action to take when the expression matches. Link to this property Description stringOptional The description of the rule. Link to this property Enabled boolOptional When set to true, the rule is enabled. Link to this property Expression stringOptional Criteria defining when there is a match for the current rule. Link to this property LastUpdated TimeOptional formatdate-time Link to this property Version stringOptional The version of the rule. Link to this property

[Link to this property](<#(resource)%20waiting_rooms.rules%20%3E%20(model)%20waiting_room_rule%20%3E%20(schema)>) #### Waiting RoomsStatuses ##### [Get waiting room status](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/statuses/methods/get) client.WaitingRooms.Statuses.Get(ctx, waitingRoomID, query) (\*[StatusGetResponse](), error) GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/status #### Waiting RoomsSettings ##### [Get zone-level Waiting Room settings](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/settings/methods/get) client.WaitingRooms.Settings.Get(ctx, query) (\*[SettingGetResponse](), error) GET/zones/{zone\_id}/waiting\_rooms/settings ##### [Update zone-level Waiting Room settings](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/settings/methods/update) client.WaitingRooms.Settings.Update(ctx, params) (\*[SettingUpdateResponse](), error) PUT/zones/{zone\_id}/waiting\_rooms/settings ##### [Patch zone-level Waiting Room settings](https://developers.cloudflare.com/api/go/resources/waiting_rooms/subresources/settings/methods/edit) client.WaitingRooms.Settings.Edit(ctx, params) (\*[SettingEditResponse](), error) PATCH/zones/{zone\_id}/waiting\_rooms/settings ##### ModelsExpand Collapse

type Setting struct{…}

SearchEngineCrawlerBypass bool Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appear in waiting room analytics. Link to this property

[Link to this property](<#(resource)%20waiting_rooms.settings%20%3E%20(model)%20setting%20%3E%20(schema)>)