Patch zone-level Waiting Room settings

client.waitingRooms.settings.edit(, ?): SettingEditResponse { search_engine_crawler_bypass }

PATCH/zones/{zone_id}/waiting_rooms/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

ParametersExpand Collapse

params: SettingEditParams { zone_id, search_engine_crawler_bypass }

zone_id: string

Path param: Identifier.

maxLength32

search_engine_crawler_bypass?: boolean

Body param: 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

SettingEditResponse { 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

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.waitingRooms.settings.edit({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(response.search_engine_crawler_bypass);

{
  "result": {
    "search_engine_crawler_bypass": true
  }
}

Returns Examples

{
  "result": {
    "search_engine_crawler_bypass": true
  }
}