Update browser session

Update a browser session.

PATCH /browsers/{id}

JavaScript

JavaScript

import Kernel from '@onkernel/sdk';

const client = new Kernel({
  apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});

const browser = await client.browsers.update('htzv5orfit78e1m2biiifpbv');

console.log(browser.session_id);

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "cdp_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/cdp?jwt=eyJ0eXAi...",
  "webdriver_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi...",
  "headless": false,
  "stealth": false,
  "session_id": "htzv5orfit78e1m2biiifpbv",
  "timeout_seconds": 123,
  "browser_live_view_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJ0eXAi...",
  "base_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/kernel",
  "gpu": false,
  "profile": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z"
  },
  "proxy_id": "<string>",
  "pool": {
    "id": "<string>",
    "name": "<string>"
  },
  "viewport": {
    "width": 1280,
    "height": 800,
    "refresh_rate": 60
  },
  "kiosk_mode": false,
  "start_url": "https://example.com",
  "chrome_policy": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "usage": {
    "uptime_ms": 123
  },
  "telemetry": {
    "browser": {
      "console": {
        "enabled": true
      },
      "page": {
        "enabled": true
      },
      "interaction": {
        "enabled": true
      },
      "network": {
        "enabled": true
      }
    }
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Browser session ID

Body

application/json

Request body for updating a browser session.

proxy_id · string | null

ID of the proxy to use. Omit to leave unchanged, set to empty string to remove proxy.

disable_default_proxy · boolean

If true, stealth browsers connect directly instead of using the default stealth proxy.

profile · object

Profile to load into the browser session. Only allowed if the session does not already have a profile loaded.

Option 1

Option 2

Show child attributes

viewport · object

Viewport configuration to apply to the browser session.

Show child attributes

telemetry · object

Telemetry configuration. Omit, set to null, or set to an empty object ({}) to leave the existing configuration unchanged (no-op). To enable capture for all categories using VM defaults, set browser to an empty object ({"browser": {}}). To stop capture, set every category's enabled to false.

Show child attributes

Response

200

application/json

Browser session updated successfully

created_at · string<date-time> · required

When the browser session was created.

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

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

headless · boolean · required

Whether the browser session is running in headless mode.

Example:

false

stealth · boolean · required

Whether the browser session is running in stealth mode.

Example:

false

session_id · string · required

Unique identifier for the browser session

Example:

"htzv5orfit78e1m2biiifpbv"

timeout_seconds · integer · required

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

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

base_url · string

Metro-API HTTP base URL for this browser session.

Example:

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

gpu · boolean

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

Example:

false

profile · object

Browser profile metadata.

Show child attributes

proxy_id · string

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

pool · object

Browser pool this session was acquired from, if any.

Show child attributes

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

Show child attributes

kiosk_mode · boolean

Whether the browser session is running in kiosk mode.

Example:

false

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"

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.

usage · object

Session usage metrics.

Show child attributes

telemetry · object

Active telemetry configuration for the session, if any.

Show child attributes