Skip to content
Cloudflare API
Start here
API Reference
Browser Rendering
Devtools
Browser

Acquire and connect to browser session.

client.browserRendering.devtools.browser.launch(BrowserLaunchParams { account_id, keep_alive, lab, 2 more } params, RequestOptionsoptions?): void
GET/accounts/{account_id}/browser-rendering/devtools/browser

Acquires and establishes a WebSocket connection to a browser session. Session guardrails may be supplied in the cf-brapi-guardrails header as base64url-encoded JSON of the same guardrails object the POST body accepts (for example {"allowedDomains":["*.example.com"]}).

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Browser Rendering WriteBrowser Rendering Read
ParametersExpand Collapse
params: BrowserLaunchParams { account_id, keep_alive, lab, 2 more }
account_id: string

Path param: Account ID.

keep_alive?: number

Query param: Keep-alive time in ms (only valid when acquiring new session).

maximum1200000
minimum10000
lab?: boolean

Query param: Use experimental browser.

recording?: boolean

Query param

cfBrapiGuardrails?: string

Header param: Optional base64url-encoded JSON session guardrails (allowedDomains and allowedDomainSets)

Acquire and connect to browser session.

import Cloudflare from 'cloudflare';

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

await client.browserRendering.devtools.browser.launch({ account_id: 'account_id' });
Returns Examples