List browser pools

List browser pools in the resolved project.

GET /browser_pools

List browser pools

cURL

curl --request GET \
  --url https://api.onkernel.com/browser_pools \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "acquired_count": 15,
    "available_count": 85,
    "browser_pool_config": {
      "size": 10,
      "chrome_policy": {},
      "extensions": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "fill_rate_per_minute": 1,
      "headless": false,
      "kiosk_mode": true,
      "name": "my-pool",
      "network": {
        "private_hosts": [
          "*.example.ts.net",
          "100.64.0.0/10"
        ]
      },
      "profile": {
        "id": "<string>",
        "name": "<string>"
      },
      "proxy_id": "<string>",
      "refresh_on_profile_update": true,
      "start_url": "https://example.com",
      "stealth": true,
      "telemetry": {
        "browser": {
          "captcha": {
            "enabled": true
          },
          "connection": {
            "enabled": true
          },
          "console": {
            "enabled": true
          },
          "control": {
            "enabled": true
          },
          "interaction": {
            "enabled": true
          },
          "network": {
            "enabled": true
          },
          "page": {
            "enabled": true
          },
          "screenshot": {
            "enabled": true
          },
          "system": {
            "enabled": true
          }
        },
        "export": {
          "otlp": {
            "destination": "<string>",
            "enabled": true
          }
        }
      },
      "timeout_seconds": 129605,
      "viewport": {
        "height": 800,
        "width": 1280,
        "refresh_rate": 60
      }
    },
    "created_at": "2023-11-07T05:31:56Z",
    "extension_ids": [
      "<string>"
    ],
    "id": "iv25ujqf37x3j07dwoffegqr",
    "name": "my-pool",
    "profile_id": "iv25ujqf37x3j07dwoffegqr"
  }
]

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.

region · enum<string>

Filter pools by geographic region. Omit to list pools in all regions. Geographic region for hosting browser sessions or pools.

Available options: us-east, eu-west

Response

200

application/json

List of browser pools

acquired_count · integer · required

Number of browsers currently acquired from the pool

Example:

15

available_count · integer · required

Number of browsers currently available in the pool

Example:

85

browser_pool_config · object · required

Configuration used to create all browsers in this pool

Show child attributes

created_at · string<date-time> · required

Timestamp when the browser pool was created

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).

id · string · required

Unique identifier for the browser pool

Example:

"iv25ujqf37x3j07dwoffegqr"

region · enum<string> · required

Geographic region of the browser pool. Fixed once the pool is created.

Available options: us-east, eu-west

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"