DashboardChangelogCareersSign up
GuidesAPI ReferenceCLIMCP

Get browser pool details

Retrieve details for a single browser pool by its ID or name.

GET/browser_pools/{id_or_name}

Retrieve details for a single browser pool by its ID or name.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id_or_name*string

Browser pool ID or name

Response

application/json

Browser pool details

A browser pool containing multiple identically configured browsers.

curl -X GET "https://example.com/browser_pools/string"
{  "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"  ]}

postCreate a browser pool

Create a new browser pool with the specified configuration and size. Pooled browsers load their profile read-only: any save_changes on the profile is ignored (not rejected), so pooled browsers never persist changes back to the profile.

patchUpdate 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`.

XGitHubLinkedIn