Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31135175384.2 KB
Browsers

Update browser session

Update a browser session.

patch/browsers/{id_or_name}

Path parameters

id_or_namestring required

Browser session ID or name

Request body

namestring nullable

Human-readable name for the browser session. Omit to leave unchanged, set to an empty string to clear the name. When set, must be unique among active sessions within the project.

tagsTags

User-defined key-value tags.

proxy_idstring nullable

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

disable_default_proxyboolean

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

Example request

{
  "name": "checkout-flow-1",
  "tags": {
    "team": "backend",
    "env": "staging"
  },
  "viewport": {
    "width": 1280,
    "height": 800,
    "refresh_rate": 60
  }
}

Response

Browser session updated successfully

created_atstring date-time required

When the browser session was created.

cdp_ws_urlstring required

Websocket URL for Chrome DevTools Protocol connections to the browser session

webdriver_ws_urlstring required

Websocket URL for WebDriver BiDi connections to the browser session

browser_live_view_urlstring

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

base_urlstring

Metro-API HTTP base URL for this browser session.

headlessboolean required

Whether the browser session is running in headless mode.

stealthboolean required

Whether the browser session is running in stealth mode.

gpuboolean

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

session_idstring required

Unique identifier for the browser session

namestring

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

timeout_secondsinteger required

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

proxy_idstring

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

kiosk_modeboolean

Whether the browser session is running in kiosk mode.

start_urlstring

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.

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.

tagsTags

User-defined key-value tags.

deleted_atstring date-time

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

Example response

{
  "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...",
  "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",
  "session_id": "htzv5orfit78e1m2biiifpbv",
  "name": "checkout-flow-1",
  "viewport": {
    "width": 1280,
    "height": 800,
    "refresh_rate": 60
  },
  "start_url": "https://example.com",
  "tags": {
    "team": "backend",
    "env": "staging"
  }
}