List browser pools

List browser pools owned by the caller’s organization.

GET /browser_pools

JavaScript

JavaScript

import Kernel from '@onkernel/sdk';

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

const browserPools = await client.browserPools.list();

console.log(browserPools);

import os
from kernel import Kernel

client = Kernel(
    api_key=os.environ.get("KERNEL_API_KEY"),  # This is the default and can be omitted
)
browser_pools = client.browser_pools.list()
print(browser_pools)

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"),
	)
	browserPools, err := client.BrowserPools.List(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", browserPools)
}

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

200

[
  {
    "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": 10,
      "timeout_seconds": 600,
      "stealth": true,
      "headless": false,
      "profile": {
        "id": "<string>",
        "name": "<string>",
        "save_changes": false
      },
      "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"
    },
    "name": "my-pool"
  }
]

{
  "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.

Response

200

application/json

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

Show child attributes

name · string

Browser pool name, if set

Example:

"my-pool"