# Kernel

## Docs

- [Custom Chrome Policies](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/browsers/chrome-policies.md): Customize Chrome behavior on individual browsers and browser pools using Chrome policies
- [Download a replay recording](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-replays/download-a-replay-recording.md): Download or stream the specified replay recording.
- [Stop a browser session replay recording](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-replays/stop-a-browser-session-replay-recording.md): Stop the specified replay recording and persist the video.
- [Stream log files on the browser instance via SSE](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-logs/stream-log-files-on-the-browser-instance-via-sse.md)
- [Stream telemetry events via SSE](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-telemetry/stream-telemetry-events-via-sse.md): Streams browser telemetry events as a server-sent events (SSE) stream. The stream closes when the browser session terminates. Each event frame includes an id: field containing a monotonically increasing sequence number; pass it as Last-Event-ID on reconnect to resume without gaps. The event: field i…
- [Read telemetry events for a browser session](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-telemetry/read-telemetry-events-for-a-browser-session.md): Reads a page of telemetry events for the browser session. To page through results, pass the X-Next-Offset value from the previous response as offset and repeat while X-Has-More is true. Returns an empty list when telemetry data is unavailable.
- [List profiles](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/profiles/list-profiles.md): List profiles with optional filtering and pagination.
- [Create a new profile](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/profiles/create-a-new-profile.md): Create a browser profile that can be used to load state into future browser sessions.
- [Get profile by ID or name](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/profiles/get-profile-by-id-or-name.md): Retrieve details for a single profile by its ID or name.
- [Delete profile by ID or name](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/profiles/delete-profile-by-id-or-name.md): Delete a profile by its ID or by its name.
- [Rename profile by ID or name](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/profiles/rename-profile-by-id-or-name.md): Update a profile's name. Names must be unique within the logical project; during the default-project migration, unscoped profiles and profiles in the org default project are treated as the same project. Duplicate-name conflicts are checked before update but are best-effort because there is no backin…
- [Download profile archive](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/profiles/download-profile-archive.md): Downloads the profile in its stored format by default. Current profiles are returned as zstd-compressed tar archives, while legacy profiles remain JSON. Set `format=tar` to decompress current profiles during download; legacy profiles remain JSON.
- [List proxies](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/proxies/list-proxies.md): List proxies in the resolved project.
- [Create a proxy](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/proxies/create-a-proxy.md): Create a new proxy configuration in the resolved project.
- [Get proxy by ID](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/proxies/get-proxy-by-id.md): Retrieve a proxy in the resolved project by ID.
- [Delete proxy by ID](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/proxies/delete-proxy-by-id.md): Soft delete a proxy. Sessions referencing it are not modified.
- [Rename proxy by ID](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/proxies/rename-proxy-by-id.md): Update a proxy's name. Proxy names are not unique and are not ID-or-name addressable on this endpoint; duplicate names are allowed. Name-based session-create lookups can remain ambiguous until callers resolve proxies by ID or the API adds a stronger uniqueness contract.
- [Check proxy health](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/proxies/check-proxy-health.md): Run a health check on the proxy to verify it's working. Optionally specify a URL to test reachability against a specific target. For ISP and datacenter proxies, this reliably tests whether the target site is reachable from the proxy's stable exit IP. For residential and mobile proxies, the exit node…
- [List browser extensions](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/extensions/list-browser-extensions.md): List extensions in the resolved project.
- [Upload a browser extension](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/extensions/upload-a-browser-extension.md): Upload a zip file containing an unpacked browser extension. Optionally provide a unique name for later reference.
- [Download extension archive](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/extensions/download-extension-archive.md): Download the extension as a ZIP archive by ID or name.
- [Delete extension by ID or name](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/extensions/delete-extension-by-id-or-name.md): Delete an extension by its ID or by its name.
- [Get extension metadata](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/extensions/get-extension-metadata.md): Get an extension's metadata (name, size, timestamps) by ID or name, without downloading the archive.
- [Download unpacked extension from Chrome Web Store](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/extensions/download-unpacked-extension-from-chrome-web-store.md): Returns a ZIP archive containing the unpacked extension fetched from the Chrome Web Store.
- [List browser pools](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-pools/list-browser-pools.md): List browser pools in the resolved project.
- [Create a browser pool](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-pools/create-a-browser-pool.md): Create a new browser pool with the specified configuration and size. Pooled browsers load their profile read-only: any save_changes on the profile is ignored (not rejected), so pooled browsers never persist changes back to the profile.
- [Get browser pool details](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-pools/get-browser-pool-details.md): Retrieve details for a single browser pool by its ID or name.
- [Delete a browser pool](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-pools/delete-a-browser-pool.md): 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.
- [Update a browser pool](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-pools/update-a-browser-pool.md): 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 `re…
- [Acquire a browser from the pool](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-pools/acquire-a-browser-from-the-pool.md): 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 t…
- [Release a browser back to the pool](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-pools/release-a-browser-back-to-the-pool.md): Release a browser back to the pool, optionally recreating the browser instance.
- [Flush all idle browsers in the pool](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/browser-pools/flush-all-idle-browsers-in-the-pool.md): Destroys all idle browsers in the pool; leased browsers are not affected.
- [List auth connections](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/list-auth-connections.md): List auth connections with optional filters for profile_name and domain.
- [Create auth connection](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/create-auth-connection.md): Creates an auth connection for a profile and domain combination. If the provided profile_name does not exist, it is created automatically. Returns 409 Conflict if an auth connection already exists for the given profile and domain.
- [Get auth connection](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/get-auth-connection.md): Retrieve an auth connection by its ID. Includes current flow state if a login is in progress.
- [Delete auth connection](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/delete-auth-connection.md): Deletes an auth connection and terminates its workflow. This will: - Delete the auth connection record - Terminate the Temporal workflow - Cancel any in-progress login flows
- [Update auth connection](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/update-auth-connection.md): Update an auth connection's configuration. Only the fields provided will be updated.
- [Start login flow](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/start-login-flow.md): Starts a login flow for the auth connection. Returns immediately with a hosted URL for the user to complete authentication, or triggers automatic re-auth if credentials are stored.
- [Submit field values](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/submit-field-values.md): Submits field values for the login form. Poll the auth connection to track progress and get results.
- [Stream login flow events via SSE](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/stream-login-flow-events-via-sse.md): Establishes a Server-Sent Events (SSE) stream that delivers real-time login flow state updates. The stream terminates automatically once the flow reaches a terminal state (SUCCESS, FAILED, EXPIRED, CANCELED).
- [Get auth connection event timeline](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/managed-auth/get-auth-connection-event-timeline.md): Returns a chronological timeline of events for an auth connection — login attempts, automatic re-auth attempts, and health checks. Events are returned newest-first.
- [List apps](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/apps/list-apps.md): List applications. Optionally filter by app name and/or version label.
- [List deployments](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/deployments/list-deployments.md): List deployments. Optionally filter by application name and version.
- [Create a deployment](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/deployments/create-a-deployment.md): Create a new deployment.
- [Get deployment details](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/deployments/get-deployment-details.md): Get information about a deployment's status.
- [Delete a deployment](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/deployments/delete-a-deployment.md): Stops a running deployment and marks it for deletion. If the deployment is already in a terminal state (stopped or failed), returns immediately.
- [Stream deployment events via SSE](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/deployments/stream-deployment-events-via-sse.md): Establishes a Server-Sent Events (SSE) stream that delivers real-time logs and status updates for a deployment. The stream terminates automatically once the deployment reaches a terminal state.
- [List invocations](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/invocations/list-invocations.md): List invocations. Optionally filter by application name, action name, status, deployment ID, or start time.
- [Invoke an action](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/invocations/invoke-an-action.md): Invoke an action.
- [Get invocation details](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/invocations/get-invocation-details.md): Get details about an invocation's status and output.
- [Update invocation](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/invocations/update-invocation.md): Update an invocation's status or output. This can be used to cancel an invocation by setting the status to "failed".
- [List browsers for an invocation](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/invocations/list-browsers-for-an-invocation.md): Returns all active browser sessions created within the specified invocation.
- [Delete browser sessions for an invocation](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/invocations/delete-browser-sessions-for-an-invocation.md): Delete all browser sessions created within the specified invocation.
- [Stream invocation events via SSE](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/invocations/stream-invocation-events-via-sse.md): Establishes a Server-Sent Events (SSE) stream that delivers real-time logs and status updates for an invocation. The stream terminates automatically once the invocation reaches a terminal state.
- [List projects](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/list-projects.md): Deprecated: use `GET /org/projects` instead. This route will be removed on 2026-11-24.
- [Create a project](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/create-a-project.md): Deprecated: use `POST /org/projects` instead. This route will be removed on 2026-11-24.
- [Get a project](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/get-a-project.md): Deprecated: use `GET /org/projects/{id}` instead. This route will be removed on 2026-11-24.
- [Delete a project](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/delete-a-project.md): Deprecated: use `DELETE /org/projects/{id}` instead. This route will be removed on 2026-11-24.
- [Update a project](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/update-a-project.md): Deprecated: use `PATCH /org/projects/{id}` instead. This route will be removed on 2026-11-24.
- [Get project limits](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/get-project-limits.md): Deprecated: use `GET /org/projects/{id}/limits` instead. This route will be removed on 2026-11-24.
- [Update project limits](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/update-project-limits.md): Deprecated: use `PATCH /org/projects/{id}/limits` instead. This route will be removed on 2026-11-24.
- [List projects](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/list-projects-1.md): List projects for the authenticated organization.
- [Create a project](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/create-a-project-1.md): Create a new project within the authenticated organization.
- [Get a project by ID or name](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/get-a-project-by-id-or-name.md): Get a project by its ID or by its name. Names are unique within an organization.
- [Delete a project](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/delete-a-project-1.md): Soft-delete a project. The project must be empty (no active resources).
- [Update a project](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/update-a-project-1.md): Update a project's name or status.
- [Get project limits](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/get-project-limits-1.md): Get the resource limit overrides for a project. Null values mean no project-level cap (org limit applies).
- [Update project limits](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/projects/update-project-limits-1.md): Update resource limit overrides for a project. Only fields present in the request are modified. Set a field to 0 to remove that limit cap; omit a field to leave it unchanged.
- [Get organization limits](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/organization/get-organization-limits.md): Get the organization's concurrency limit — the maximum browsers running at once across on-demand sessions and browser pool reservations — and the default per-project concurrency cap applied to projects without an explicit override.
- [Update organization limits](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/organization/update-organization-limits.md): Set the default per-project concurrency cap applied to projects without an explicit override. Set the value to 0 to remove the default; omit to leave it unchanged. The default cannot exceed the organization's concurrency limit.
- [List API keys](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/api-keys/list-api-keys.md): List API keys for the authenticated organization. API keys are masked.
- [Create an API key](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/api-keys/create-an-api-key.md): Create a new API key within the authenticated organization.
- [Get an API key](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/api-keys/get-an-api-key.md): Retrieve an API key by ID for the authenticated organization. API keys are masked.
- [Delete an API key](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/api-keys/delete-an-api-key.md): Delete an API key. A key cannot delete itself; use a different key to delete this one.
- [Update an API key](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/api-keys/update-an-api-key.md): Update an API key's name.
- [Rotate an API key](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/api-keys/rotate-an-api-key.md): Rotate an API key. Issues a new key that copies the name and project of the rotated key, and schedules the rotated key to expire after a grace period so in-flight callers can swap over. The new plaintext key is returned once.
- [List audit logs](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/audit-logs/list-audit-logs.md): API for searching audit logs. Limited to at most 30 day search, returns up to 100 records per page. Not recommended for bulk export.
- [Download an audit-log export chunk](https://tbd-6fc993ce-hypeship-browser-pools-docs-refresh.mintlify.site/api-reference/audit-logs/download-an-audit-log-export-chunk.md): Download an organization's audit log records for a time range as a file, for archival, compliance, or offline analysis. For interactive browsing, use GET /audit-logs.

## Optional

- [Changelog](https://www.kernel.sh/changelog)