Update a browser pool

Updates the configuration used to create browsers in the pool. As with creation, save_changes on the pool profile is ignored (not rejected); pooled browsers never persist changes back to the profile. To clear the profile reference, send `profile: { "id": "" }`. Clearing the profile also disables `refresh_on_profile_update`.

PATCH/browser_pools/{id_or_name}

Updates the configuration used to create browsers in the pool. As with creation, save_changes on the pool profile is ignored (not rejected); pooled browsers never persist changes back to the profile. To clear the profile reference, send profile: { "id": "" }. Clearing the profile also disables refresh_on_profile_update.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id_or_name*string

Browser pool ID or name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for updating a browser pool. Omitted fields leave existing values unchanged.

size?integer

If provided, replaces the number of browsers to maintain in the pool. The maximum size is determined by your organization's pooled sessions limit (the sum of all pool sizes cannot exceed your limit).

Range1 <= value

name?string

If provided, replaces the pool name. Empty string is a no-op; the pool name cannot be cleared or reset to empty once assigned.

Match^[a-zA-Z0-9._-]{1,255}$

fill_rate_per_minute?integer

If provided, replaces the percentage of the pool to fill per minute. The cap is 25 for most organizations but can be raised per-organization, so only the lower bound is enforced here.

Range0 <= value

timeout_seconds?integer

If provided, replaces the default idle timeout in seconds for browsers acquired from this pool before they are destroyed. Minimum 10, maximum 259200 (72 hours).

Range10 <= value <= 259200

stealth?boolean

If provided, replaces whether browsers launch in stealth mode.

headless?boolean

If provided, replaces whether browsers launch using a headless image.

profile?|

Profile configuration for browsers in a pool. Provide either id or name. Profiles must be created beforehand. Unlike single browser sessions, pools load the profile read-only and never persist changes back to it, so save_changes is omitted here. Any save_changes value sent on a pool profile is silently ignored rather than rejected.

refresh_on_profile_update?boolean

If provided, replaces whether idle browsers are flushed when the profile the pool uses is updated. When the pool's profile reference is changed (including newly attached) and this field is omitted, it defaults to true. Re-sending the same profile reference leaves this setting unchanged. Clearing the profile also disables this setting. Requires a profile to be set on the pool.

extensions?array<|>

If provided, replaces the extension list. Empty array clears all previously-selected extensions. Omit this field to leave extensions unchanged.

Itemsitems <= 20

proxy_id?string

Empty string clears the previously-selected proxy. Omit this field to leave the proxy unchanged.

viewport?

If provided, replaces the viewport with the new width/height/refresh_rate. Because width and height are required and must be positive, the viewport cannot be cleared; omit this field to leave it unchanged.

kiosk_mode?boolean

If provided, replaces whether browsers launch in kiosk mode.

chrome_policy?

If provided, replaces the custom Chrome enterprise policy overrides applied to all browsers in this pool. Empty object clears any previously-set policy. Keys are Chrome enterprise policy names; values must match their expected types. Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See https://chromeenterprise.google/policies/ The serialized JSON payload is capped at 5 MiB.

start_url?string

If provided, replaces the URL to navigate to when a new browser is warmed into the pool. Empty string clears the previously-set URL. Omit this field to leave it unchanged.

Lengthlength <= 2048

telemetry?

If provided, updates the pool's telemetry configuration. Omit, set to null, or set to an empty object ({}) to leave the existing configuration unchanged. Set enabled to true to enable capture using the default set. Set enabled to false to clear the pool's telemetry. Provide browser category settings for per-category updates, merged onto the pool's current configuration. Only applied to browsers warmed after the update; browsers already in the pool keep their configuration until discarded.

discard_all_idle?boolean

Whether to discard all idle browsers and rebuild them immediately with the new configuration. Defaults to false. Only browsers that are idle when the update runs are rebuilt. A browser that is in use during the update keeps its original configuration, and if it is later released with reuse: true it returns to the pool with that stale configuration until it is discarded (by this flag on a later update, or by flushing the pool).

Defaultfalse

Response

application/json

Browser pool details

A browser pool containing multiple identically configured browsers.

id*string

Unique identifier for the browser pool

name?string

Browser pool name, if set

available_count*integer

Number of browsers currently available in the pool

acquired_count*integer

Number of browsers currently acquired from the pool

created_at*string

Timestamp when the browser pool was created

Formatdate-time

browser_pool_config*

Configuration used to create all browsers in this pool

profile_id?string

Resolved profile ID the pool is attached to. Omitted when no profile is attached. Authoritative for programmatic consumers; the profile inside browser_pool_config reflects the configured selector (echoed as sent on create).

extension_ids*array<string>

Resolved extension IDs attached to the pool, in configured load order. Empty when no extensions are attached. Authoritative for programmatic consumers; the extensions inside browser_pool_config reflect the configured selector (echoed as sent on create).

curl -X PATCH "https://example.com/browser_pools/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "available_count": 0,  "acquired_count": 0,  "created_at": "2019-08-24T14:15:22Z",  "browser_pool_config": {    "size": 1,    "name": "string",    "fill_rate_per_minute": 0,    "timeout_seconds": 10,    "stealth": true,    "headless": true,    "profile": {      "id": "string",      "name": "string"    },    "refresh_on_profile_update": true,    "extensions": [      {        "id": "string",        "name": "string"      }    ],    "proxy_id": "string",    "viewport": {      "width": 1,      "height": 1,      "refresh_rate": 1    },    "kiosk_mode": true,    "chrome_policy": {},    "start_url": "string",    "telemetry": {      "browser": {        "console": {          "enabled": true        },        "page": {          "enabled": true        },        "interaction": {          "enabled": true        },        "network": {          "enabled": true        },        "control": {          "enabled": true        },        "connection": {          "enabled": true        },        "system": {          "enabled": true        },        "screenshot": {          "enabled": true        },        "captcha": {          "enabled": true        }      }    }  },  "profile_id": "string",  "extension_ids": [    "string"  ]}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}