Skip to main content
GET
List browser sessions

Authorizations

Authorization
string
header
required

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

Query Parameters

status
enum<string>
default:active

Filter sessions by status. "active" returns only active sessions (default), "deleted" returns only soft-deleted sessions, "all" returns both.

Available options:
active,
deleted,
all
include_deleted
boolean
default:false

Deprecated: Use status=all instead. When true, includes soft-deleted browser sessions in the results alongside active sessions.

limit
integer
default:20

Maximum number of results to return. Defaults to 20, maximum 100.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of results to skip. Defaults to 0.

Required range: x >= 0
query
string

Search browsers by name, session ID, profile name or ID, proxy ID, or pool name.

tags
object

Filter sessions by tag key-value pairs using deepObject style, e.g. ?tags[team]=backend&tags[env]=staging. Multiple pairs are ANDed: a session must match every supplied pair exactly.

region
enum<string>

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

Available options:
us-east,
eu-west

Response

List of browsers

cdp_ws_url
string
required

Websocket URL for Chrome DevTools Protocol connections to the browser session

Example:

"wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/cdp?jwt=eyJ0eXAi..."

created_at
string<date-time>
required

When the browser session was created.

headless
boolean
required

Whether the browser session is running in headless mode.

Example:

false

region
enum<string>
required

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

Available options:
us-east,
eu-west
session_id
string
required

Unique identifier for the browser session

Example:

"htzv5orfit78e1m2biiifpbv"

stealth
boolean
required

Whether the browser session is running in stealth mode.

Example:

false

timeout_seconds
integer
required

The number of seconds of inactivity before the browser session is terminated.

webdriver_ws_url
string
required

Websocket URL for WebDriver BiDi connections to the browser session

Example:

"wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi..."

base_url
string

Metro-API HTTP base URL for this browser session.

Example:

"https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/kernel"

browser_live_view_url
string

Remote URL for live viewing the browser session. Only available for non-headless browsers.

Example:

"https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJ0eXAi..."

chrome_policy
object

Custom Chrome enterprise policy overrides that were applied to this browser session, if any. Echoed back for verification. Keys are Chrome enterprise policy names.

deleted_at
string<date-time>

When the browser session was soft-deleted. Only present for deleted sessions.

gpu
boolean

Whether GPU acceleration is enabled for the browser session (only supported for headful sessions).

Example:

false

kiosk_mode
boolean

Whether the browser session is running in kiosk mode.

Example:

false

name
string

Human-readable name of the browser session, if one was set at creation.

Example:

"checkout-flow-1"

network
object

Network configuration the session was created with, if any. Omitted when the session has no network configuration.

pool
object

Browser pool this session was acquired from, if any.

profile
object

Browser profile metadata.

profile_save_changes
boolean

Whether changes made during this browser session are saved back to its profile when the session ends. Omitted when no profile is attached.

proxy
object

Resolved proxy configuration for this browser session.

proxy_id
string
deprecated

ID of the proxy associated with this browser session, if any. Deprecated in favor of proxy.

start_url
string

URL the session was asked to navigate to on creation, if any. Recorded for debugging. Navigation is fire-and-forget — the URL is dispatched to the browser without waiting for it to load, and any errors (DNS failure, bad status, timeout) are silently dropped. Captures what was requested, not what the browser actually loaded.

Example:

"https://example.com"

tags
object

User-defined key-value tags that were set on this browser session, if any. Echoed back when present.

Example:
telemetry
object | null

Active telemetry configuration for the session, if any.

usage
object

Session usage metrics.

viewport
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. Arbitrary viewport dimensions and refresh rates are accepted. Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For GPU images, recommended presets use one of these resolutions with refresh rates 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view or recording behavior. If refresh_rate is not provided, it will be automatically determined based on the resolution (higher resolutions use lower refresh rates to keep bandwidth reasonable).