Pools
Update a pool
Resize, pause, resume, or reconfigure a browser pool.
PATCH
/
v1
/
browser
/
pools
/
{poolId}
Update a pool
curl --request PATCH \
--url https://api.driver.dev/v1/browser/pools/{poolId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"size": 1,
"browser": {
"nodeId": "<string>",
"country": "<string>",
"proxyUrl": "<string>",
"windowSize": "<string>",
"displaySize": "<string>",
"url": "<string>",
"timezone": "<string>",
"language": "<string>",
"acceptLang": "<string>",
"ttsLanguage": "<string>",
"disableSpeechApi": true,
"adblock": true,
"captchaSolver": true,
"extensionIds": [
"<string>"
],
"note": "<string>",
"gpu": "<string>",
"tags": [
"<string>"
]
},
"leaseTimeoutSeconds": 43215,
"maxReadyAgeSeconds": 43215,
"paused": true
}
'import requests
url = "https://api.driver.dev/v1/browser/pools/{poolId}"
payload = {
"name": "<string>",
"size": 1,
"browser": {
"nodeId": "<string>",
"country": "<string>",
"proxyUrl": "<string>",
"windowSize": "<string>",
"displaySize": "<string>",
"url": "<string>",
"timezone": "<string>",
"language": "<string>",
"acceptLang": "<string>",
"ttsLanguage": "<string>",
"disableSpeechApi": True,
"adblock": True,
"captchaSolver": True,
"extensionIds": ["<string>"],
"note": "<string>",
"gpu": "<string>",
"tags": ["<string>"]
},
"leaseTimeoutSeconds": 43215,
"maxReadyAgeSeconds": 43215,
"paused": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
size: 1,
browser: {
nodeId: '<string>',
country: '<string>',
proxyUrl: '<string>',
windowSize: '<string>',
displaySize: '<string>',
url: '<string>',
timezone: '<string>',
language: '<string>',
acceptLang: '<string>',
ttsLanguage: '<string>',
disableSpeechApi: true,
adblock: true,
captchaSolver: true,
extensionIds: ['<string>'],
note: '<string>',
gpu: '<string>',
tags: ['<string>']
},
leaseTimeoutSeconds: 43215,
maxReadyAgeSeconds: 43215,
paused: true
})
};
fetch('https://api.driver.dev/v1/browser/pools/{poolId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.driver.dev/v1/browser/pools/{poolId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'size' => 1,
'browser' => [
'nodeId' => '<string>',
'country' => '<string>',
'proxyUrl' => '<string>',
'windowSize' => '<string>',
'displaySize' => '<string>',
'url' => '<string>',
'timezone' => '<string>',
'language' => '<string>',
'acceptLang' => '<string>',
'ttsLanguage' => '<string>',
'disableSpeechApi' => true,
'adblock' => true,
'captchaSolver' => true,
'extensionIds' => [
'<string>'
],
'note' => '<string>',
'gpu' => '<string>',
'tags' => [
'<string>'
]
],
'leaseTimeoutSeconds' => 43215,
'maxReadyAgeSeconds' => 43215,
'paused' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.driver.dev/v1/browser/pools/{poolId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"size\": 1,\n \"browser\": {\n \"nodeId\": \"<string>\",\n \"country\": \"<string>\",\n \"proxyUrl\": \"<string>\",\n \"windowSize\": \"<string>\",\n \"displaySize\": \"<string>\",\n \"url\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"acceptLang\": \"<string>\",\n \"ttsLanguage\": \"<string>\",\n \"disableSpeechApi\": true,\n \"adblock\": true,\n \"captchaSolver\": true,\n \"extensionIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"gpu\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"leaseTimeoutSeconds\": 43215,\n \"maxReadyAgeSeconds\": 43215,\n \"paused\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.driver.dev/v1/browser/pools/{poolId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"size\": 1,\n \"browser\": {\n \"nodeId\": \"<string>\",\n \"country\": \"<string>\",\n \"proxyUrl\": \"<string>\",\n \"windowSize\": \"<string>\",\n \"displaySize\": \"<string>\",\n \"url\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"acceptLang\": \"<string>\",\n \"ttsLanguage\": \"<string>\",\n \"disableSpeechApi\": true,\n \"adblock\": true,\n \"captchaSolver\": true,\n \"extensionIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"gpu\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"leaseTimeoutSeconds\": 43215,\n \"maxReadyAgeSeconds\": 43215,\n \"paused\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.driver.dev/v1/browser/pools/{poolId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"size\": 1,\n \"browser\": {\n \"nodeId\": \"<string>\",\n \"country\": \"<string>\",\n \"proxyUrl\": \"<string>\",\n \"windowSize\": \"<string>\",\n \"displaySize\": \"<string>\",\n \"url\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"acceptLang\": \"<string>\",\n \"ttsLanguage\": \"<string>\",\n \"disableSpeechApi\": true,\n \"adblock\": true,\n \"captchaSolver\": true,\n \"extensionIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"gpu\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"leaseTimeoutSeconds\": 43215,\n \"maxReadyAgeSeconds\": 43215,\n \"paused\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "pool_8ca73065e49d44f3a7825743745b2948",
"name": "<string>",
"size": 1,
"status": "warming",
"ready": 1,
"starting": 1,
"leased": 1,
"browser": {
"nodeId": "<string>",
"country": "<string>",
"proxyUrl": "<string>",
"windowSize": "<string>",
"displaySize": "<string>",
"url": "<string>",
"timezone": "<string>",
"language": "<string>",
"acceptLang": "<string>",
"ttsLanguage": "<string>",
"disableSpeechApi": true,
"profile": {
"name": "<string>",
"persist": true
},
"adblock": true,
"captchaSolver": true,
"extensionIds": [
"<string>"
],
"note": "<string>",
"gpu": "<string>",
"tags": [
"<string>"
]
},
"leaseTimeoutSeconds": 1,
"maxReadyAgeSeconds": 1,
"lastError": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
A workspace API key from Settings → API keys in the dashboard (https://app.driver.dev), sent as a bearer token.
Path Parameters
Required string length:
6 - 80Example:
"pool_8ca73065e49d44f3a7825743745b2948"
Body
application/json
Required string length:
1 - 64Required range:
x > 0Replaces the browser template as a whole and rebuilds the warm browsers from it. Leave it out to keep the current template.
Show child attributes
Show child attributes
Required range:
30 <= x <= 86400Required range:
30 <= x <= 86400true stops the warm browsers and refuses acquires; false warms them again.
Response
Success
Required string length:
6 - 80Example:
"pool_8ca73065e49d44f3a7825743745b2948"
Required range:
x > 0Available options:
warming, ready, degraded, paused, deleting Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Show child attributes
Show child attributes
Required range:
x > 0Required range:
x > 0⌘I
Update a pool
curl --request PATCH \
--url https://api.driver.dev/v1/browser/pools/{poolId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"size": 1,
"browser": {
"nodeId": "<string>",
"country": "<string>",
"proxyUrl": "<string>",
"windowSize": "<string>",
"displaySize": "<string>",
"url": "<string>",
"timezone": "<string>",
"language": "<string>",
"acceptLang": "<string>",
"ttsLanguage": "<string>",
"disableSpeechApi": true,
"adblock": true,
"captchaSolver": true,
"extensionIds": [
"<string>"
],
"note": "<string>",
"gpu": "<string>",
"tags": [
"<string>"
]
},
"leaseTimeoutSeconds": 43215,
"maxReadyAgeSeconds": 43215,
"paused": true
}
'import requests
url = "https://api.driver.dev/v1/browser/pools/{poolId}"
payload = {
"name": "<string>",
"size": 1,
"browser": {
"nodeId": "<string>",
"country": "<string>",
"proxyUrl": "<string>",
"windowSize": "<string>",
"displaySize": "<string>",
"url": "<string>",
"timezone": "<string>",
"language": "<string>",
"acceptLang": "<string>",
"ttsLanguage": "<string>",
"disableSpeechApi": True,
"adblock": True,
"captchaSolver": True,
"extensionIds": ["<string>"],
"note": "<string>",
"gpu": "<string>",
"tags": ["<string>"]
},
"leaseTimeoutSeconds": 43215,
"maxReadyAgeSeconds": 43215,
"paused": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
size: 1,
browser: {
nodeId: '<string>',
country: '<string>',
proxyUrl: '<string>',
windowSize: '<string>',
displaySize: '<string>',
url: '<string>',
timezone: '<string>',
language: '<string>',
acceptLang: '<string>',
ttsLanguage: '<string>',
disableSpeechApi: true,
adblock: true,
captchaSolver: true,
extensionIds: ['<string>'],
note: '<string>',
gpu: '<string>',
tags: ['<string>']
},
leaseTimeoutSeconds: 43215,
maxReadyAgeSeconds: 43215,
paused: true
})
};
fetch('https://api.driver.dev/v1/browser/pools/{poolId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.driver.dev/v1/browser/pools/{poolId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'size' => 1,
'browser' => [
'nodeId' => '<string>',
'country' => '<string>',
'proxyUrl' => '<string>',
'windowSize' => '<string>',
'displaySize' => '<string>',
'url' => '<string>',
'timezone' => '<string>',
'language' => '<string>',
'acceptLang' => '<string>',
'ttsLanguage' => '<string>',
'disableSpeechApi' => true,
'adblock' => true,
'captchaSolver' => true,
'extensionIds' => [
'<string>'
],
'note' => '<string>',
'gpu' => '<string>',
'tags' => [
'<string>'
]
],
'leaseTimeoutSeconds' => 43215,
'maxReadyAgeSeconds' => 43215,
'paused' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.driver.dev/v1/browser/pools/{poolId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"size\": 1,\n \"browser\": {\n \"nodeId\": \"<string>\",\n \"country\": \"<string>\",\n \"proxyUrl\": \"<string>\",\n \"windowSize\": \"<string>\",\n \"displaySize\": \"<string>\",\n \"url\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"acceptLang\": \"<string>\",\n \"ttsLanguage\": \"<string>\",\n \"disableSpeechApi\": true,\n \"adblock\": true,\n \"captchaSolver\": true,\n \"extensionIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"gpu\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"leaseTimeoutSeconds\": 43215,\n \"maxReadyAgeSeconds\": 43215,\n \"paused\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.driver.dev/v1/browser/pools/{poolId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"size\": 1,\n \"browser\": {\n \"nodeId\": \"<string>\",\n \"country\": \"<string>\",\n \"proxyUrl\": \"<string>\",\n \"windowSize\": \"<string>\",\n \"displaySize\": \"<string>\",\n \"url\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"acceptLang\": \"<string>\",\n \"ttsLanguage\": \"<string>\",\n \"disableSpeechApi\": true,\n \"adblock\": true,\n \"captchaSolver\": true,\n \"extensionIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"gpu\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"leaseTimeoutSeconds\": 43215,\n \"maxReadyAgeSeconds\": 43215,\n \"paused\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.driver.dev/v1/browser/pools/{poolId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"size\": 1,\n \"browser\": {\n \"nodeId\": \"<string>\",\n \"country\": \"<string>\",\n \"proxyUrl\": \"<string>\",\n \"windowSize\": \"<string>\",\n \"displaySize\": \"<string>\",\n \"url\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"acceptLang\": \"<string>\",\n \"ttsLanguage\": \"<string>\",\n \"disableSpeechApi\": true,\n \"adblock\": true,\n \"captchaSolver\": true,\n \"extensionIds\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"gpu\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"leaseTimeoutSeconds\": 43215,\n \"maxReadyAgeSeconds\": 43215,\n \"paused\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "pool_8ca73065e49d44f3a7825743745b2948",
"name": "<string>",
"size": 1,
"status": "warming",
"ready": 1,
"starting": 1,
"leased": 1,
"browser": {
"nodeId": "<string>",
"country": "<string>",
"proxyUrl": "<string>",
"windowSize": "<string>",
"displaySize": "<string>",
"url": "<string>",
"timezone": "<string>",
"language": "<string>",
"acceptLang": "<string>",
"ttsLanguage": "<string>",
"disableSpeechApi": true,
"profile": {
"name": "<string>",
"persist": true
},
"adblock": true,
"captchaSolver": true,
"extensionIds": [
"<string>"
],
"note": "<string>",
"gpu": "<string>",
"tags": [
"<string>"
]
},
"leaseTimeoutSeconds": 1,
"maxReadyAgeSeconds": 1,
"lastError": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}