Sign in
latestOpenAPI 3.1.02026-08-22154287463.4 KB

858365328f92

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

disable_default_proxyboolean

If true, stealth browsers connect directly instead of using the default stealth proxy. Deprecated in favor of proxy.mode.

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.

proxy_idstring nullable

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

tagsTags

User-defined key-value tags.

Example request

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

Response

Browser session updated successfully

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.

memory'1GiB' | '2GiB' | '6GiB' | '8GiB' | '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' | 'eu-west' required

Geographic region for hosting browser sessions or pools.

session_idstring required

Unique identifier for the browser session

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.

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.

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...",
  "memory": "8GiB",
  "name": "checkout-flow-1",
  "network": {
    "private_hosts": [
      "*.example.ts.net",
      "100.64.0.0/10"
    ]
  },
  "session_id": "htzv5orfit78e1m2biiifpbv",
  "start_url": "https://example.com",
  "tags": {
    "env": "staging",
    "team": "backend"
  },
  "viewport": {
    "height": 800,
    "refresh_rate": 60,
    "width": 1280
  },
  "webdriver_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi..."
}