Skip to main content
POST
Create a pool

Authorizations

Authorization
string
header
required

A workspace API key from Settings → API keys in the dashboard (https://app.driver.dev), sent as a bearer token.

Body

application/json
name
string
required

Unique in the workspace, 1 to 64 characters.

Required string length: 1 - 64
size
integer
required

Browsers to keep ready. All pools together may keep 30 warm per account.

Required range: x > 0
browser
object

The create options every browser in the pool starts with (same fields as POST /v1/browser/session, without type, duration and browserCheck). Validated like a create body (an unsupported country is a 400). Responses echo the template with the resolved timezone and a redacted proxyUrl.

leaseTimeoutSeconds
integer

How long an acquired browser may be held, in seconds (30 to 86400, default 900). The session is stopped when the lease expires.

Required range: 30 <= x <= 86400
maxReadyAgeSeconds
integer

How long a browser may wait ready before it is replaced with a fresh one, in seconds (30 to 86400, default 3600).

Required range: 30 <= x <= 86400

Response

Pool created

id
string
required
Required string length: 6 - 80
Example:

"pool_8ca73065e49d44f3a7825743745b2948"

name
string
required
size
integer
required
Required range: x > 0
status
enum<string>
required
Available options:
warming,
ready,
degraded,
paused,
deleting
ready
integer
required
Required range: x >= 0
starting
integer
required
Required range: x >= 0
leased
integer
required
Required range: x >= 0
browser
object
required
leaseTimeoutSeconds
integer
required
Required range: x > 0
maxReadyAgeSeconds
integer
required
Required range: x > 0
lastError
string | null
required
createdAt
string
required
updatedAt
string
required