Skip to main content
PATCH
Update 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.

Path Parameters

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

"pool_8ca73065e49d44f3a7825743745b2948"

Body

application/json
name
string
Required string length: 1 - 64
size
integer
Required range: x > 0
browser
object

Replaces the browser template as a whole and rebuilds the warm browsers from it. Leave it out to keep the current template.

leaseTimeoutSeconds
integer
Required range: 30 <= x <= 86400
maxReadyAgeSeconds
integer
Required range: 30 <= x <= 86400
paused
boolean

true stops the warm browsers and refuses acquires; false warms them again.

Response

Success

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