POST /accounts/{account_id}/browser-rendering/devtools/browser
Acquires a browser and returns its session ID and websocket URL. Optionally accepts a JSON body with session guardrails to restrict outbound HTTP/S traffic.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id |
String | Yes |
Account ID. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
keep_alive |
Number | No |
Keep-alive time in milliseconds. Default value: 60000 |
liveViewUrlExpiresInMs |
Number | No |
How long the live view URL remains valid, in milliseconds (max 60 minutes). Only used when targets is true. Default value: 300000 |
lab |
Boolean | No |
Use experimental browser. Default value: false |
targets |
Boolean | No |
Include browser targets in response. Default value: false |
recording |
Boolean | No |
Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
guardrails |
Object | No | |
guardrails.allowedDomainSets[] |
Array | No |
Max 4 entries: curated preset names (common-cdns) and/or https URLs of newline-separated hostname lists. |
guardrails.allowedDomains[] |
Array | No |
Hostname patterns, max 50. Supports exact hosts (example.com) or a single * wildcard anywhere. Prefer *.example.com (subdomain wildcard) over *example.com (prefix wildcard) to avoid matching overbroad lookalikes like evilexample.com. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.