Skip to main content
GET
/
browser_pools
JavaScript
import Kernel from '@onkernel/sdk';

const client = new Kernel({
  apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const browserPool of client.browserPools.list()) {
  console.log(browserPool.id);
}
import os
from kernel import Kernel

client = Kernel(
api_key=os.environ.get("KERNEL_API_KEY"), # This is the default and can be omitted
)
page = client.browser_pools.list()
page = page.items[0]
print(page.id)
package main

import (
"context"
"fmt"

"github.com/kernel/kernel-go-sdk"
"github.com/kernel/kernel-go-sdk/option"
)

func main() {
client := kernel.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.BrowserPools.List(context.TODO(), kernel.BrowserPoolListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
curl --request GET \
--url https://api.onkernel.com/browser_pools \
--header 'Authorization: Bearer <token>'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onkernel.com/browser_pools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
HttpResponse<String> response = Unirest.get("https://api.onkernel.com/browser_pools")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/browser_pools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "iv25ujqf37x3j07dwoffegqr",
    "available_count": 85,
    "acquired_count": 15,
    "created_at": "2023-11-07T05:31:56Z",
    "browser_pool_config": {
      "size": 10,
      "name": "my-pool",
      "fill_rate_per_minute": 1,
      "timeout_seconds": 129605,
      "stealth": true,
      "headless": false,
      "profile": {
        "id": "<string>",
        "name": "<string>"
      },
      "refresh_on_profile_update": true,
      "extensions": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "proxy_id": "<string>",
      "viewport": {
        "width": 1280,
        "height": 800,
        "refresh_rate": 60
      },
      "kiosk_mode": true,
      "chrome_policy": {},
      "start_url": "https://example.com"
    },
    "extension_ids": [
      "<string>"
    ],
    "name": "my-pool",
    "profile_id": "iv25ujqf37x3j07dwoffegqr"
  }
]
{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}
{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}
{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20

Limit the number of browser pools to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Offset the number of browser pools to return.

Required range: x >= 0
query
string

Case-insensitive substring match against browser pool name. IDs match by exact value.

name
string

Exact-match filter on browser pool name using the database collation. In production, matching is case- and accent-insensitive. During the default-project migration, unscoped requests prefer a concrete default-project browser pool over a legacy unscoped browser pool with the same name.

Response

List of browser pools

id
string
required

Unique identifier for the browser pool

Example:

"iv25ujqf37x3j07dwoffegqr"

available_count
integer
required

Number of browsers currently available in the pool

Example:

85

acquired_count
integer
required

Number of browsers currently acquired from the pool

Example:

15

created_at
string<date-time>
required

Timestamp when the browser pool was created

browser_pool_config
object
required

Configuration used to create all browsers in this pool

extension_ids
string[]
required

Resolved extension IDs attached to the pool, in configured load order. Empty when no extensions are attached. Authoritative for programmatic consumers; the extensions inside browser_pool_config reflect the configured selector (echoed as sent on create).

name
string

Browser pool name, if set

Example:

"my-pool"

profile_id
string

Resolved profile ID the pool is attached to. Omitted when no profile is attached. Authoritative for programmatic consumers; the profile inside browser_pool_config reflects the configured selector (echoed as sent on create).

Example:

"iv25ujqf37x3j07dwoffegqr"