[ Web Proxy ]
URL:
Viewing: https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/settings/methods/edit [Back]  [Original]
Patch zone-level Waiting Room settings | Cloudflare API Skip to content
logo.DMYpXs3t.svg [logo.DMYpXs3t.svg] Cloudflare API
CtrlK
Start here
Start here
HTTP
API Reference
Waiting Rooms
Settings
Copy Markdown

Patch zone-level Waiting Room settings

PATCH/zones/{zone_id}/waiting_rooms/settings

Patch zone-level Waiting Room settings.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Waiting Rooms Write
Path ParametersExpand Collapse
zone_id: string

Identifier.

maxLength32
Body ParametersJSONExpand Collapse
search_engine_crawler_bypass: optional boolean

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.

ReturnsExpand Collapse
result: object { search_engine_crawler_bypass }
search_engine_crawler_bypass: boolean

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.

Patch zone-level Waiting Room settings

HTTP
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms/settings \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "search_engine_crawler_bypass": true
        }'
200 example
{
  "result": {
    "search_engine_crawler_bypass": true
  }
}
Returns Examples
200 example
{
  "result": {
    "search_engine_crawler_bypass": true
  }
}
Web Proxy Viewer  |  New URL  |  Original Page