ONonkernel
Browser Pools

Get browser pool details

Changed on

Retrieve details for a single browser pool by its ID or name.

get/browser_pools/{id_or_name}

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/browser_pools/{id_or_name}
  • Auth
    HTTP bearer

Path parameters

id_or_namestring required

Browser pool ID or name

Response

Browser pool details

acquired_countinteger required

Number of browsers currently acquired from the pool

available_countinteger required

Number of browsers currently available in the pool

created_atstring date-time required

Timestamp when the browser pool was created

extension_idsstring[] 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).

idstring required

Unique identifier for the browser pool

namestring

Browser pool name, if set

profile_idstring

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

region'us-east' | 'us-west' | 'eu-west' | 'ap-southeast' required

Geographic region for hosting browser sessions or pools.

Example response

{
  "acquired_count": 15,
  "available_count": 85,
  "browser_pool_config": {
    "kiosk_mode": true,
    "memory": "8GiB",
    "name": "my-pool",
    "network": {
      "allowed_hosts": [
        "example.com",
        "*.example.com"
      ],
      "private_hosts": [
        "*.example.ts.net",
        "100.64.0.0/10"
      ]
    },
    "refresh_on_profile_update": true,
    "size": 10,
    "start_url": "https://example.com",
    "stealth": true,
    "viewport": {
      "height": 800,
      "refresh_rate": 60,
      "width": 1280
    }
  },
  "id": "iv25ujqf37x3j07dwoffegqr",
  "name": "my-pool",
  "profile_id": "iv25ujqf37x3j07dwoffegqr"
}

Changes

  • df28b52a4950Revision changes
    • info

      added the optional property // to the response with the status

  • 90be865f0e7cRevision changes
    • warning

      added the new 4GiB enum value to the ///// response property for the response status