> ## Documentation Index > Fetch the complete documentation index at: https://kernel.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a browser pool > 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. ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/kernel/openapi.documented.yml patch /browser_pools/{id_or_name} openapi: 3.1.0 info: title: Kernel API description: Developer tools and cloud infrastructure for AI agents to use web browsers version: 0.1.0 servers: - url: https://api.onkernel.com description: API Server security: - bearerAuth: [] tags: - name: Browsers description: Create and manage browser sessions. - name: Browser Computer Controls description: Control mouse, keyboard, and screen on the browser instance. - name: Browser Playwright description: Execute Playwright code against the browser instance. - name: Browser Filesystem description: Read, write, and manage files on the browser instance. - name: Browser Processes description: Execute and manage processes on the browser instance. - name: Browser Replays description: Record and manage browser session video replays. - name: Browser Logs description: Stream logs from the browser instance. - name: Browser Telemetry description: Stream live telemetry events from a browser session. - name: Profiles description: Create, list, retrieve, and delete browser profiles. - name: Proxies description: Create and manage proxy configurations for routing browser traffic. - name: Extensions description: Create, list, retrieve, and delete browser extensions. - name: Browser Pools description: Create and manage browser pools for acquiring and releasing browsers. - name: Managed Auth description: >- Create and manage auth connections for automated credential capture and login. - name: Credentials description: Create and manage credentials for authentication. - name: Credential Providers description: Configure external credential providers like 1Password. - name: Apps description: List applications and versions. - name: Deployments description: Create and manage app deployments and stream deployment events. - name: Invocations description: Invoke actions and stream or query invocation status and events. - name: Organization description: Read and manage organization-level limits. - name: Projects description: Create and manage projects for resource isolation within an organization. - name: API Keys description: Create and manage API keys for organization and project-scoped access. - name: Audit Logs description: Read audit log records for the authenticated organization. paths: /browser_pools/{id_or_name}: patch: tags: - Browser Pools summary: Update a browser pool description: > 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. operationId: updateBrowserPoolsByIdOrName parameters: - name: id_or_name in: path required: true schema: type: string description: Browser pool ID or name requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BrowserPoolUpdateRequest' responses: '200': description: Browser pool details content: application/json: schema: $ref: '#/components/schemas/BrowserPool' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' security: - bearerAuth: [] x-codeSamples: - lang: JavaScript source: |- import Kernel from '@onkernel/sdk'; const client = new Kernel({ apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted }); const browserPool = await client.browserPools.update('id_or_name'); console.log(browserPool.id); - lang: Python source: |- import os from kernel import Kernel client = Kernel( api_key=os.environ.get("KERNEL_API_KEY"), # This is the default and can be omitted ) browser_pool = client.browser_pools.update( id_or_name="id_or_name", ) print(browser_pool.id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/kernel/kernel-go-sdk\"\n\t\"github.com/kernel/kernel-go-sdk/option\"\n)\n\nfunc main() {\n\tclient := kernel.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tbrowserPool, err := client.BrowserPools.Update(\n\t\tcontext.TODO(),\n\t\t\"id_or_name\",\n\t\tkernel.BrowserPoolUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", browserPool.ID)\n}\n" components: schemas: BrowserPoolUpdateRequest: type: object description: > Parameters for updating a browser pool. All browsers in the pool will be created with the same configuration. allOf: - $ref: '#/components/schemas/BrowserPoolConfig' - type: object properties: size: type: integer description: > Number of browsers to maintain in the pool. The maximum size is determined by your organization's pooled sessions limit (the sum of all pool sizes cannot exceed your limit). minimum: 1 example: 10 discard_all_idle: type: boolean description: >- Whether to discard all idle browsers and rebuild the pool immediately. Defaults to false. example: false default: false BrowserPool: type: object description: A browser pool containing multiple identically configured browsers. properties: id: type: string description: Unique identifier for the browser pool example: iv25ujqf37x3j07dwoffegqr name: type: string description: Browser pool name, if set example: my-pool available_count: type: integer description: Number of browsers currently available in the pool example: 85 acquired_count: type: integer description: Number of browsers currently acquired from the pool example: 15 created_at: type: string format: date-time description: Timestamp when the browser pool was created browser_pool_config: $ref: '#/components/schemas/BrowserPoolRequest' description: Configuration used to create all browsers in this pool required: - id - available_count - acquired_count - created_at - browser_pool_config BrowserPoolConfig: type: object description: > Browser pool configuration shared by create, update, and response bodies. properties: name: type: string pattern: ^[a-zA-Z0-9._-]{1,255}$ description: >- Optional name for the browser pool. Must be unique within the project. example: my-pool fill_rate_per_minute: type: integer description: >- Percentage of the pool to fill per minute. Defaults to 10. The cap is 25 for most organizations but can be raised per-organization, so only the lower bound is enforced here. minimum: 0 default: 10 timeout_seconds: type: integer description: >- Default idle timeout in seconds for browsers acquired from this pool before they are destroyed. Defaults to 600 seconds. Minimum 10, maximum 259200 (72 hours). minimum: 10 maximum: 259200 default: 600 stealth: type: boolean description: >- If true, launches the browser in stealth mode to reduce detection by anti-bot mechanisms. example: true headless: type: boolean description: >- If true, launches the browser using a headless image. Defaults to false. example: false profile: $ref: '#/components/schemas/BrowserPoolProfile' extensions: type: array description: >- List of browser extensions to load into the session. Provide each by id or name. maxItems: 20 items: $ref: '#/components/schemas/BrowserExtension' proxy_id: type: string description: >- Optional proxy to associate to the browser session. Must reference a proxy in the same project as the browser session. viewport: $ref: '#/components/schemas/BrowserViewport' kiosk_mode: type: boolean description: >- If true, launches the browser in kiosk mode to hide address bar and tabs in live view. example: true chrome_policy: type: object additionalProperties: true description: > Custom Chrome enterprise policy overrides applied to all browsers in this pool. Keys are Chrome enterprise policy names; values must match their expected types. Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See https://chromeenterprise.google/policies/ start_url: type: string description: >- Optional URL to navigate to when a new browser is warmed into the pool. Best-effort: failures to navigate do not fail pool fill. Only applied to newly-warmed browsers; browsers reused via release/acquire keep whatever URL the previous lease left them on. Accepts any URL Chromium can resolve, including chrome:// pages. example: https://example.com BrowserPoolRequest: type: object description: > Parameters for creating a browser pool. All browsers in the pool will be created with the same configuration. allOf: - $ref: '#/components/schemas/BrowserPoolConfig' - type: object properties: size: type: integer description: > Number of browsers to maintain in the pool. The maximum size is determined by your organization's pooled sessions limit (the sum of all pool sizes cannot exceed your limit). minimum: 1 example: 10 required: - size Error: type: object required: - code - message properties: code: type: string description: Application-specific error code (machine-readable) example: bad_request message: type: string description: Human-readable error description for debugging example: 'Missing required field: app_name' details: type: array description: Additional error details (for multiple errors) items: $ref: '#/components/schemas/ErrorDetail' inner_error: $ref: '#/components/schemas/ErrorDetail' BrowserPoolProfile: type: object description: > Profile selection for browsers in a pool. Provide either id or name. The matching profile is loaded into every browser in the pool. Profiles must be created beforehand. Unlike single browser sessions, pools load the profile read-only and never persist changes back to it, so save_changes is omitted here. Any save_changes value sent on a pool profile is silently ignored rather than rejected, so callers reusing a single-session profile object will not error. properties: id: type: string description: Profile ID to load for browsers in this pool name: type: string minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9._-]{1,255}$ description: >- Profile name to load for browsers in this pool (instead of id). Must be 1-255 characters, using letters, numbers, dots, underscores, or hyphens. oneOf: - required: - id - required: - name BrowserExtension: type: object description: > Extension selection for the browser session. Provide either id or name of an extension uploaded to Kernel. properties: id: type: string description: Extension ID to load for this browser session name: type: string minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9._-]{1,255}$ description: >- Extension name to load for this browser session (instead of id). Must be 1-255 characters, using letters, numbers, dots, underscores, or hyphens. oneOf: - required: - id - required: - name BrowserViewport: type: object description: > 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. 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). properties: width: type: integer description: Browser window width in pixels. Any positive integer is accepted. minimum: 1 example: 1280 height: type: integer description: Browser window height in pixels. Any positive integer is accepted. minimum: 1 example: 800 refresh_rate: type: integer description: >- Display refresh rate in Hz. Any positive integer is accepted; if omitted, automatically determined from width and height. minimum: 1 example: 60 required: - width - height ErrorDetail: type: object properties: code: type: string description: Lower-level error code providing more specific detail example: invalid_input message: type: string description: Further detail about the error example: Provided version string is not semver compliant responses: BadRequest: description: Bad Request – invalid input content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Unauthorized – missing or invalid authorization token content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: Forbidden – insufficient permissions or plan content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Error' Conflict: description: Conflict – resource already exists content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: Too Many Requests – rate limit exceeded headers: Retry-After: description: Seconds to wait before retrying schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' InternalError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer ````