ONonkernel
Browsers

List browser sessions

Changed on

List all browser sessions with pagination support. Use status parameter to filter by session state.

get/browsers

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/browsers
  • Auth
    HTTP bearer

Query parameters

status'active' | 'deleted' | 'all'

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

include_deletedboolean

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

limitinteger

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

offsetinteger

Number of results to skip. Defaults to 0.

querystring

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

tagsobject

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'us-east' | 'us-west' | 'eu-west' | 'ap-southeast'

Geographic region for hosting browser sessions or pools.

Filter sessions by geographic region. Omit to list sessions in all regions.

Response

List of browsers

base_urlstring

Metro-API HTTP base URL for this browser session.

browser_live_view_urlstring

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

cdp_ws_urlstring required

Websocket URL for Chrome DevTools Protocol connections to the browser session

chrome_policyobject

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

created_atstring date-time required

When the browser session was created.

deleted_atstring date-time

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

gpuboolean

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

headlessboolean required

Whether the browser session is running in headless mode.

kiosk_modeboolean

Whether the browser session is running in kiosk mode.

leased_atstring date-time

When the pooled browser session was last leased. Only present for leased pooled sessions.

memory'1GiB' | '2GiB' | '4GiB' | '6GiB' | '8GiB' | '12GiB' | '16GiB' required

Memory allocated to the browser session.

namestring

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

profile_save_changesboolean

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

proxy_idstring

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

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

Geographic region for hosting browser sessions or pools.

session_idstring required

Unique identifier for the browser session

start_urlstring

URL the session was most recently asked to navigate to, 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.

stealthboolean required

Whether the browser session is running in stealth mode.

tagsTags

User-defined key-value tags.

timeout_secondsinteger required

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

usage_status'pending' | 'ready'

Whether final usage billing is still pending or complete. Only present for deleted sessions.

video_memory'2GiB' | '4GiB'

Video memory (VRAM) of a GPU browser session. 2GiB sessions have 4 vCPU and 6GiB memory. 4GiB sessions have 8 vCPU and 12GiB memory.

webdriver_ws_urlstring required

Websocket URL for WebDriver BiDi connections to the browser session

Example response

[
  {
    "base_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/kernel",
    "browser_live_view_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJ0eXAi...",
    "cdp_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/cdp?jwt=eyJ0eXAi...",
    "location": {
      "locale": "en-US",
      "timezone": "America/Los_Angeles"
    },
    "memory": "8GiB",
    "name": "checkout-flow-1",
    "network": {
      "allowed_hosts": [
        "example.com",
        "*.example.com"
      ],
      "private_hosts": [
        "*.example.ts.net",
        "100.64.0.0/10"
      ]
    },
    "session_id": "htzv5orfit78e1m2biiifpbv",
    "start_url": "https://example.com",
    "tags": {
      "env": "staging",
      "team": "backend"
    },
    "video_memory": "2GiB",
    "viewport": {
      "height": 800,
      "refresh_rate": 60,
      "width": 1280
    },
    "webdriver_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi..."
  }
]

Changes

  • 8fd2b1497fc2Revision changes
    • info

      added the optional property / to the response with the status

  • f50629e71df4Revision changes
    • warning

      added the new default enum value to the // response property for the response status

    • warning

      added the new default enum value to the // response property for the response status

    • info

      removed the metro enum value from the // response property for the response status

    • info

      removed the metro enum value from the // response property for the response status