Skip to main content
Manage pools of pre-warmed browser instances for fast acquisition.

Actions

ActionDescription
createSet up a pool.
listList pools.
getInspect a specific pool.
acquireGet a browser from a pool.
releaseReturn a browser to a pool.
flushDestroy idle browsers in a pool.
deleteRemove a pool.

Parameters

ParameterDescription
actionOperation to perform. Required.
id_or_namePool ID or name. Required for get, delete, flush, acquire, and release.
name(create) Unique pool name.
size(create) Number of browsers to maintain in the pool.
fill_rate_per_minute(create) Pool fill rate percentage per minute. Default 10%.
headless(create) Headless mode for pool browsers.
stealth(create) Stealth mode for pool browsers.
profile_name(create) Profile to load into pool browsers.
proxy_id(create) Proxy for pool browsers.
timeout_seconds(create) Idle timeout for acquired browsers. Default 600.
acquire_timeout_seconds(acquire) Max seconds to wait for a browser.
session_id(release) Session ID of the browser to release.
reuse(release) Reuse the browser instance or recreate it. Default true.
force(delete) Force delete even if browsers are leased.

Example

{
  "action": "create",
  "name": "scrape-pool",
  "size": 5,
  "stealth": true
}