import Kernel from '@onkernel/sdk';
const client = new Kernel({
apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});
const browserPool = await client.browserPools.retrieve('id_or_name');
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
)
browser_pool = client.browser_pools.retrieve(
"id_or_name",
)
print(browser_pool.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"),
)
browserPool, err := client.BrowserPools.Get(context.TODO(), "id_or_name")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", browserPool.ID)
}curl --request GET \
--url https://api.onkernel.com/browser_pools/{id_or_name} \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onkernel.com/browser_pools/{id_or_name}",
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/{id_or_name}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onkernel.com/browser_pools/{id_or_name}")
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",
"telemetry": {
"browser": {
"console": {
"enabled": true
},
"page": {
"enabled": true
},
"interaction": {
"enabled": true
},
"network": {
"enabled": true
},
"control": {
"enabled": true
},
"connection": {
"enabled": true
},
"system": {
"enabled": true
},
"screenshot": {
"enabled": true
},
"captcha": {
"enabled": true
}
}
}
},
"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"
}
}{
"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"
}
}Get browser pool details
Retrieve details for a single browser pool by its ID or name.
import Kernel from '@onkernel/sdk';
const client = new Kernel({
apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});
const browserPool = await client.browserPools.retrieve('id_or_name');
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
)
browser_pool = client.browser_pools.retrieve(
"id_or_name",
)
print(browser_pool.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"),
)
browserPool, err := client.BrowserPools.Get(context.TODO(), "id_or_name")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", browserPool.ID)
}curl --request GET \
--url https://api.onkernel.com/browser_pools/{id_or_name} \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onkernel.com/browser_pools/{id_or_name}",
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/{id_or_name}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onkernel.com/browser_pools/{id_or_name}")
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",
"telemetry": {
"browser": {
"console": {
"enabled": true
},
"page": {
"enabled": true
},
"interaction": {
"enabled": true
},
"network": {
"enabled": true
},
"control": {
"enabled": true
},
"connection": {
"enabled": true
},
"system": {
"enabled": true
},
"screenshot": {
"enabled": true
},
"captcha": {
"enabled": true
}
}
}
},
"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"
}
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Browser pool ID or name
Response
Browser pool details
A browser pool containing multiple identically configured browsers.
Unique identifier for the browser pool
"iv25ujqf37x3j07dwoffegqr"
Number of browsers currently available in the pool
85
Number of browsers currently acquired from the pool
15
Timestamp when the browser pool was created
Configuration used to create all browsers in this pool
Show child attributes
Show child attributes
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).
Browser pool name, if set
"my-pool"
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).
"iv25ujqf37x3j07dwoffegqr"