Skip to main content
POST
Acquire a browser

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.

Path Parameters

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

"pool_8ca73065e49d44f3a7825743745b2948"

Body

application/json
waitMs
integer
default:0

How long to wait for a browser to become ready when none is, in milliseconds (0 to 30000). Send {} for no wait; the body is required.

Required range: 0 <= x <= 30000

Response

Success

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

"pool_8ca73065e49d44f3a7825743745b2948"

leaseId
string
required
acquiredAt
string
required
expiresAt
string
required
session
object
required