Skip to main content
GET
/
browser_pools
/
{id_or_name}
Get browser pool details
curl --request GET \
  --url https://api.onkernel.com/browser_pools/{id_or_name} \
  --header 'Authorization: Bearer <token>'
{
  "id": "iv25ujqf37x3j07dwoffegqr",
  "name": "my-pool",
  "available_count": 85,
  "acquired_count": 15,
  "created_at": "2023-11-07T05:31:56Z",
  "browser_pool_config": {
    "name": "my-pool",
    "size": 10,
    "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
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id_or_name
string
required

Browser pool ID or name

Response

Browser pool details

A browser pool containing multiple identically configured browsers.

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

name
string

Browser pool name, if set

Example:

"my-pool"