Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kernel Browser Pools API

Create and manage browser pools for acquiring and releasing browsers.

Kernel Browser Pools API is one of 22 APIs that Kernel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Browser Pools. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 5 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.onkernel.com.

8 operations 5 paths 21 schemas 1 DELETE2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.onkernel.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kernel Browser Pools API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Browser Pools 8

Create and manage browser pools for acquiring and releasing browsers.

POST
/browser_pools
Create a browser pool
postBrowserPools body → 201400401403409429500
GET
/browser_pools
List browser pools
getBrowserPools 4 params → 200401403500
GET
/browser_pools/{id_or_name}
Get browser pool details
getBrowserPoolsByIdOrName 1 param → 200401403404500
PATCH
/browser_pools/{id_or_name}
Update a browser pool
updateBrowserPoolsByIdOrName 1 param body → 200400401403404409429500
DELETE
/browser_pools/{id_or_name}
Delete a browser pool
deleteBrowserPoolsByIdOrName 1 param body → 204400401403404500
POST
/browser_pools/{id_or_name}/acquire
Acquire a browser from the pool
acquireFromBrowserPoolByIdOrName 1 param body → 200204400401403404409500
POST
/browser_pools/{id_or_name}/release
Release a browser back to the pool
releaseToBrowserPoolByIdOrName 1 param body → 204400401403404500
POST
/browser_pools/{id_or_name}/flush
Flush all idle browsers in the pool
flushBrowserPoolByIdOrName 1 param → 204401403404500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Browser (22 properties), BrowserPoolUpdateRequest (16 properties), BrowserPoolConfig (15 properties), BrowserPoolCreateRequest (15 properties). Each schema is shown below with its type and property counts.

BrowserPoolUpdateRequest
object
Parameters for updating a browser pool. Omitted fields leave existing values unchanged.
16 properties
BrowserTelemetryCategoriesConfig
object
Per-category telemetry capture settings layered onto the default set. The operational signals (control, connection, system, captcha) are on by default and are…
9 properties
BrowserPoolCreateRequest
object
Parameters for creating a browser pool. All browsers in the pool will be created with the same configuration.
15 properties 1 required
BrowserTelemetryRequestConfig
object
Telemetry request configuration for a browser session.
2 properties
Browser
object
22 properties 7 required
BrowserPoolReleaseRequest
object
Request body for releasing a browser back to the pool.
2 properties 1 required
BrowserPoolAcquireRequest
object
Request body for acquiring a browser from the pool.
5 properties
Profile
object
Browser profile metadata.
5 properties 2 required
BrowserUsage
object
Session usage metrics.
1 property 1 required
ErrorDetail
object
2 properties
BrowserViewport
object
Initial browser window size in pixels with optional refresh rate. If omitted, image defaults apply (1920x1080@25). For GPU images, the default is 1920x1080@60.…
3 properties 2 required
Error
object
4 properties 2 required
BrowserTelemetryConfig
object
Active telemetry configuration for a browser session.
1 property
BrowserExtension
object
Extension selection for the browser session. Provide either id or name of an extension uploaded to Kernel.
2 properties
BrowserPoolProfile
object
Profile configuration for browsers in a pool. Provide either id or name. Profiles must be created beforehand. Unlike single browser sessions, pools load the pr…
2 properties
BrowserPoolDeleteRequest
object
Parameters for deleting a browser pool.
1 property
Tags
object
User-defined key-value tags.
BrowserPool
object
A browser pool containing multiple identically configured browsers.
8 properties 6 required
BrowserPoolRef
object
Browser pool this session was acquired from, if any.
2 properties 1 required
BrowserPoolConfig
object
Effective browser pool configuration returned by the API.
15 properties 1 required
BrowserTelemetryCategoryConfig
object
Per-category telemetry configuration.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kernel-browser-pools-api-openapi.yml Raw ↑

Other APIs Kernel publishes across the network.

Kernel API Keys API
Kernel Apps API
Kernel Audit Logs API
Kernel Browser Computer Controls API
Kernel Browser Filesystem API
Kernel Browser Logs API
Kernel Browser Playwright API
Kernel Browser Processes API
Kernel Browser Replays API
Kernel Browser Telemetry API
Kernel Browsers API
Kernel Credential Providers API