DashboardChangelogCareersSign up
GuidesAPI ReferenceCLIMCP
DELETE/browser_pools/{id_or_name}

Delete a browser pool and all browsers in it. By default, deletion is blocked if browsers are currently leased. Use force=true to terminate leased browsers.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id_or_name*string

Browser pool ID or name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for deleting a browser pool.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/browser_pools/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Update a browser pool PATCH

Updates the configuration used to create browsers in the pool. As with creation, save_changes on the pool profile is ignored (not rejected); pooled browsers never persist changes back to the profile. To clear the profile reference, send `profile: { "id": "" }`. Clearing the profile also disables `refresh_on_profile_update`.

Acquire a browser from the pool POST

Long-polling endpoint to acquire a browser from the pool. Returns immediately when a browser is available, or returns 204 No Content when the poll times out. The client should retry the request to continue waiting for a browser. The acquired browser will use the pool's timeout_seconds for its idle timeout.