Update browser session
Update a browser session.
Authorizations
Body
Request body for updating a browser session.
Session-only timezone and locale overrides. Omit the object or a field to leave it unchanged; set a string to override; set null to clear that field and use the browser region's default. A browser that cannot change location refuses the request before anything changes. The location applies after the request's other changes, and start_url opens once it has applied. If applying it fails, the other changes and the saved override remain and start_url does not open; retry the request to apply both.
Proxy configuration to apply. Omit to leave the current configuration unchanged. Cannot be combined with proxy_id or disable_default_proxy. Set mode to direct to switch to direct egress. Set mode to default to use Kernel's default stealth proxy for a browser with CAPTCHA solving enabled, or direct egress otherwise. Updating proxy does not change CAPTCHA solver behavior.
- Option 1
- Option 2
- Option 3
Optional URL to navigate the browser to after applying this update. When a profile is loaded in the same update, this overrides the profile's restored tabs. Navigation is best-effort, so failures do not fail the update. Omit or set to an empty string to leave the current page unchanged.
2048"https://example.com"
Telemetry configuration. Omit, set to null, or set to an empty object ({}) to leave the existing configuration unchanged. Set enabled to true to enable capture using VM defaults. Set enabled to false to stop capture. Provide browser category settings for per-category updates. Explicitly disabling all four categories also stops capture.
Response
Browser session updated successfully
Whether the browser session has CAPTCHA solving enabled, in which case proxy.mode=default uses Kernel's default stealth proxy. A browser created with only captcha_solver reports true with proxy.mode=direct. Deprecated in favor of captcha_solver and proxy.
false
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.
"https://example.com"
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).