Kernel browsers accept an optionalDocumentation Index
Fetch the complete documentation index at: https://tbd-6fc993ce-hypeship-docs-chrome-policy-on-demand.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
chrome_policy object that lets you apply Chrome enterprise policies to the browser at launch. Use this to control startup behavior, default homepages, bookmarks, download UI, notifications, and other browser-level settings.
chrome_policy is supported on:
browsers.create()— on-demand browser sessionsbrowserPools.create()andbrowserPools.update()— reserved browser pools
On-demand browsers
Passchrome_policy when creating an on-demand browser. The policy is applied at session creation time.
GET /browsers/{id} and GET /browsers responses so you can verify what was applied.
Reserved browser pools
Passchrome_policy when creating or updating a pool. Every browser in the pool launches with the policy applied. See Custom chrome policies on pools for the pool-specific update flow (including discard_all_idle).
Example policies
| Policy | Type | Description |
|---|---|---|
HomepageLocation | string | URL loaded when clicking the home button |
HomepageIsNewTabPage | boolean | When false, the home button navigates to HomepageLocation instead of the new tab page |
ShowHomeButton | boolean | Shows the home button in the toolbar |
NewTabPageLocation | string | URL shown when opening a new tab |
RestoreOnStartup | integer | Set to 4 to open a specific list of URLs on browser startup |
RestoreOnStartupURLs | string[] | URLs to open when the browser starts. Requires RestoreOnStartup set to 4 |
BookmarkBarEnabled | boolean | Shows the bookmark bar |
ManagedBookmarks | array | Pre-configured bookmarks. Supports folders via nested children arrays |
DownloadBubbleEnabled | boolean | Controls the download bubble UI. Set to false to fall back to the classic download shelf |
Available policies
Any policy listed in the Chrome Enterprise policy documentation can be used in thechrome_policy object. Refer to the official docs for the full list of supported policy names, types, and values.