Update browser session

PATCH/browsers/{id_or_name}

Update a browser session.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id_or_name*string

Browser session ID or name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for updating a browser session.

name?string

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.

Match^[a-zA-Z0-9._-]{1,255}$

Length1 <= length <= 255

tags?

User-defined key-value tags for the browser session. Omit to leave unchanged. Provide a map to replace the entire tag set (full replace, not a merge). Set to an empty object ({}) to clear all tags. Up to 50 pairs.

Propertiesproperties <= 50

proxy_id?string

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?|

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

viewport?

Viewport configuration to apply to the browser session.

telemetry?

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 Body

`application/json`

curl -X PATCH "https://example.com/browsers/htzv5orfit78e1m2biiifpbv" \  -H "Content-Type: application/json" \  -d '{}'

{  "created_at": "2019-08-24T14:15:22Z",  "cdp_ws_url": "string",  "webdriver_ws_url": "string",  "browser_live_view_url": "string",  "base_url": "string",  "headless": true,  "stealth": true,  "gpu": true,  "session_id": "string",  "name": "string",  "timeout_seconds": 0,  "profile": {    "id": "string",    "name": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "last_used_at": "2019-08-24T14:15:22Z"  },  "proxy_id": "string",  "pool": {    "id": "string",    "name": "string"  },  "viewport": {    "width": 1,    "height": 1,    "refresh_rate": 1  },  "kiosk_mode": true,  "start_url": "string",  "chrome_policy": {},  "tags": {    "property1": "string",    "property2": "string"  },  "deleted_at": "2019-08-24T14:15:22Z",  "usage": {    "uptime_ms": 0  },  "telemetry": {    "browser": {      "console": {        "enabled": true      },      "page": {        "enabled": true      },      "interaction": {        "enabled": true      },      "network": {        "enabled": true      },      "control": {        "enabled": true      },      "connection": {        "enabled": true      },      "system": {        "enabled": true      },      "screenshot": {        "enabled": true      },      "captcha": {        "enabled": true      }    }  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`