{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}
{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}
{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}
{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}
{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}
{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}
Managed Auth
Start login flow
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.
Controls whether this login reads and writes learned domain skills. Automatic reauths inherit the selected mode until a later accepted login sets enabled or omits this field. Defaults to enabled when omitted.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Kernel","colors":{"primary":"#212225","light":"#CAB168","dark":"#CAB168"},"logo":{"light":"https://mintcdn.com/tbd-6fc993ce/Lt3m2NlMiCztMtQK/logo/black.svg?fit=max\u0026auto=format\u0026n=Lt3m2NlMiCztMtQK\u0026q=85\u0026s=68e987c751954bbc1d35886a02636c73","dark":"https://mintcdn.com/tbd-6fc993ce/y3CmyOX_b9m5t8tc/logo/white.svg?fit=max\u0026auto=format\u0026n=y3CmyOX_b9m5t8tc\u0026q=85\u0026s=c197f34af93346f9141a9a79870f101e"},"favicon":"https://mintcdn.com/tbd-6fc993ce/G-Oz940pmbilrFx5/favicon.svg?fit=max\u0026auto=format\u0026n=G-Oz940pmbilrFx5\u0026q=85\u0026s=ce38e3ee0e5d07700bccd70f5df08733","appearance":{"default":"light","strict":false},"background":{"color":{"light":"#F0F0F3","dark":"#212225"}},"navbar":{"links":[{"href":"https://dashboard.onkernel.com","label":"Dashboard"},{"href":"https://jobs.ashbyhq.com/usekernel","label":"Careers"}],"primary":{"type":"button","label":"Sign up","href":"https://dashboard.onkernel.com/sign-up"}},"footer":{"socials":{"x":"https://x.com/usekernel","github":"https://github.com/orgs/kernel","linkedin":"https://www.linkedin.com/company/trykernel"}},"seo":{"metatags":{"canonical":"https://www.kernel.sh/docs","og:image":"https://www.kernel.sh/docs/images/og-image.png","twitter:image":"https://www.kernel.sh/docs/images/og-image.png"},"indexing":"all"},"fonts":{"family":"Inter","weight":400},"integrations":{"ga4":{"measurementId":"G-GVEXRLYSN4"}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tbd-6fc993ce","hasAudioNarration":false,"actualSubdomain":"tbd-6fc993ce","customDomains":["www.kernel.sh"],"gitSource":{"type":"github","owner":"kernel","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4301f0c59e275effff739","collectionId":"801f3a20-be5f-438c-ae29-21e630e0c574","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4301f0c59e275effff739"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4af7e5507c0d0db08bc81","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":166},{"language":"default","tag":"Guides","count":91},{"language":"default","tag":"How it works","count":68},{"language":"default","tag":"Configure","count":39},{"language":"default","tag":"MCP","count":31},{"language":"default","tag":"Vaults","count":23},{"language":"default","tag":"Managed Auth","count":15},{"language":"default","tag":"Partnering with KERNEL","count":15},{"language":"default","tag":"CLI","count":15},{"language":"default","tag":"Browser Filesystem","count":15}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"*{text-transform:lowercase!important}.kernel-brand-name{text-transform:uppercase!important}.code-group code,.code-group pre,[class*=highlight] code,[class*=highlight] pre,code,code *,kbd,pre,pre *{text-transform:none!important}*,::after,::before{border-radius:0!important}:root{--btn-selected-bg:#CAB168;--btn-border:#000}#navigation-items .sidebar-group-header{font-weight:300!important;font-size:11px!important}html.dark #navigation-items .sidebar-group-header{color:rgba(237,238,240,.55)!important}#navigation-items div[class*=mt-]>.sidebar-group-header{margin-top:.75rem;padding-top:1rem;border-top:1px solid rgba(33,34,37,.1)}html.dark #navigation-items div[class*=mt-]>.sidebar-group-header{border-top-color:rgba(237,238,240,.1)}#navigation-items li[data-title]>button.group,#navigation-items li[data-title]>div.group{width:100%!important;flex-direction:row-reverse!important;justify-content:space-between!important}#navigation-items li[data-title]>button.group>svg,#navigation-items li[data-title]>div.group>svg{margin-right:0!important;margin-left:0!important}.prose table,article table,table{width:100%!important;border-collapse:separate!important;border-spacing:0!important;border-radius:0!important;overflow:hidden!important;border:1px solid rgb(var(--gray-950)/.1)!important;background-color:#f9fafb!important;margin:0!important;display:table!important}.prose table thead th,article table thead th,table thead th{padding:10px 16px!important;text-align:left!important;font-weight:600!important;font-size:.875rem!important;line-height:1.5rem!important;background-color:rgba(0,0,0,.02)!important;border-bottom:1px solid rgba(0,0,0,.1)!important;word-wrap:break-word!important;word-break:break-word!important;overflow-wrap:break-word!important;white-space:normal!important;max-width:0!important}.prose table tbody tr,article table tbody tr,table tbody tr{transition:background-color .15s ease!important;border-bottom:1px solid rgba(0,0,0,.06)!important}.prose table tbody tr:last-child,article table tbody tr:last-child,table tbody tr:last-child{border-bottom:none!important}.prose table tbody tr:hover,article table tbody tr:hover,table tbody tr:hover{background-color:rgba(0,0,0,.02)!important}.prose table tbody td,article table tbody td,table tbody td{padding:10px 16px!important;font-size:.875rem!important;line-height:1.5rem!important;word-wrap:break-word!important;word-break:break-word!important;overflow-wrap:break-word!important;white-space:normal!important;max-width:0!important;min-width:130px!important}.prose table code,article table code,table code{font-size:.8125rem!important;padding:2px 6px!important;border-radius:0!important}.prose code:not(pre *),article code:not(pre *),code:not(pre *){padding:1px 4px!important;background-color:transparent!important;border:1px solid #d0d2d9!important}html.dark .prose code:not(pre *),html.dark article code:not(pre *),html.dark code:not(pre *){border-color:rgba(237,238,240,.1)!important}.prose table tbody td:first-child,article table tbody td:first-child,table tbody td:first-child{font-weight:500!important}.tinker-box{display:flex;flex-direction:column;gap:32px;padding:32px;border:1px solid rgba(0,0,0,.12);margin-top:2rem;margin-bottom:2rem}.tinker-box-row{display:flex;align-items:center;gap:32px}.tinker-box-content{display:flex;flex-direction:column;gap:32px;flex:1;min-width:0}.copy-prompt-full button,.tinker-box-content button{width:100%!important;max-width:100%!important}@media (max-width:640px){.tinker-box{padding:24px;gap:24px}.tinker-box-row{flex-direction:column;align-items:stretch;gap:24px;width:100%}.tinker-box-content{width:100%}}html.dark .callout[class*=yellow],html.dark .prose table,html.dark article table,html.dark table{border-color:rgba(237,238,240,.1)!important;background-color:rgba(237,238,240,.02)!important}html.dark .prose table thead th,html.dark article table thead th,html.dark table thead th{background-color:rgba(237,238,240,.04)!important;border-bottom-color:rgba(237,238,240,.1)!important}html.dark .prose table tbody tr,html.dark article table tbody tr,html.dark table tbody tr{border-bottom-color:rgba(237,238,240,.08)!important}html.dark .prose table tbody tr:hover,html.dark article table tbody tr:hover,html.dark table tbody tr:hover{background-color:rgba(237,238,240,.04)!important}html.dark .tinker-box{border-color:rgba(237,238,240,.14)}html.dark{--btn-border:#EDEEF0}html.dark .callout[class*=yellow]{background-color:rgba(237,238,240,.03)!important}html.dark .callout[class*=yellow] svg{color:#cab168!important}.dark .card:hover{border-color:rgb(223 223 223)!important}.dark .link{border-bottom-color:#edeef0}#navigation-items img[src*=\"/images/integration-icons/\"]{width:14px;height:14px;opacity:.68}#navigation-items img[src*=\"/images/integration-icons/nousresearch.svg\"]{opacity:.72;transform:scale(1.06)}#navigation-items img[src*=\"/images/integration-icons/browser-use-logo-transparent.svg\"]{transform:scale(.9)}#navigation-items img[src*=\"/images/integration-icons/computer-cursor-rounded.svg\"]{transform:scale(.95)}#navigation-items img[src*=\"/images/integration-icons/laminar-outline.svg\"]{transform:scale(.9)}#navigation-items img[src*=\"/images/integration-icons/stagehand-logo-transparent.svg\"]{transform:scale(.88)}#navigation-items img[src*=\"/images/integration-icons/stripe.svg\"]{transform:scale(.82)}#navigation-items img[src*=\"/images/integration-icons/vercel.svg\"]{transform:scale(.76)}#navigation-items img[src*=\"/images/integration-icons/1password-logo-transparent.svg\"]{opacity:.6;transform:scale(.82)}#navigation-items li>button:has(img[src*=\"/images/integration-icons/\"])>div:has(>svg){order:1}#navigation-items li>button:has(img[src*=\"/images/integration-icons/\"])>div:has(>img[src*=\"/images/integration-icons/\"]){order:3}#navigation-items li>button:has(img[src*=\"/images/integration-icons/\"])>div:not(:has(>svg)):not(:has(>img[src*=\"/images/integration-icons/\"])){order:2}html.dark #navigation-items img[src*=\"/images/integration-icons/\"]{filter:invert(1)}#pagination a[href^=\"/cookbooks/\"]{display:none}#header .eyebrow[data-parent-group]{font-size:0}#header .eyebrow[data-parent-group]::after{content:attr(data-parent-group);font-size:.875rem}.cookbook-tag{display:block;font-size:.6875rem;font-weight:400;letter-spacing:-.015em;opacity:.72;margin-bottom:.5rem}html.dark .cookbook-tag{color:rgba(237,238,240,.7)}html[data-current-path=\"/\"] #header>div.prose{display:none!important}"}],"page":{"pagePath":"api-reference/managed-auth/start-login-flow","slug":"/api-reference/managed-auth/start-login-flow","pageMetadata":{"title":"Start login flow","description":"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.","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /auth/connections/{id}/login","href":"/api-reference/managed-auth/start-login-flow","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"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.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Start login flow","description":"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.","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /auth/connections/{id}/login","href":"/api-reference/managed-auth/start-login-flow","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tbd-6fc993ce/ab7a5fd22e95880d/conceptual.js","/docs/_mintlify/custom/tbd-6fc993ce/08c6845006936328/eyebrow.js"],"openApiReferenceData":{"operation":{"description":"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.","operationId":"postAuthConnectionsLogin","parameters":["7011a3f6-5235-437b-a930-919bccb846a3"],"requestBody":"eac2c8e4-caba-4a1f-adb5-5a74a7f3a272","responses":{"200":"f556ce9e-e180-46f8-9ed1-23443213f7c9","400":"a18ebb9a-00ea-494e-81be-34e2830803ba","401":"84f55d16-3246-43df-9c9b-b067e4ba5e9b","403":"288c1b2f-aad2-48b0-b0fc-d9715dae6ad1","404":"0f2fccc8-02f9-4ea3-b888-63af6d91b26f","409":"ba83dcfb-8305-4d8f-b0e6-f3fc6b28b6ed","500":"6a1b3b55-33a5-4c0f-986f-cba9290b607b"},"security":["ec0b8db4-dd2c-4afc-8196-0c375c3ccc9e"],"summary":"Start login flow","tags":["Managed Auth"],"method":"post","type":"path","servers":["334ce7c4-2851-4bdf-a5c8-e2a3ff581b12"],"path":"/auth/connections/{id}/login","baseUrlOptions":["https://api.onkernel.com"],"title":"Start login flow","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7011a3f6-5235-437b-a930-919bccb846a3":{"description":"Auth connection ID","in":"path","name":"id","required":true,"schema":{"type":"string","isRequired":true,"description":"Auth connection ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Request to start a login flow","properties":{"browser":{"additionalProperties":false,"description":"Browser configuration override for this login. Omitted properties inherit the connection defaults.","properties":{"proxy":{"oneOf":[{"type":"object","description":"Proxy configuration for managed auth browser sessions. Omit on create to derive the default from stealth, or on update and login to preserve or inherit the connection default.","required":["mode"],"properties":{"mode":{"description":"Proxy egress mode. direct forces no proxy regardless of stealth. default uses the browser's stealth-derived default: Kernel's default stealth proxy when stealth=true, or direct egress when stealth=false.\ndefault is primarily useful on browser update to restore the browser default after selected-proxy egress.\n","enum":["direct","default"],"type":"string","x-enum-varnames":["Direct","Default"],"isRequired":true,"uniqueKey":"browser.proxy.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"id":{"description":"Proxy ID.","minLength":1,"type":"string","uniqueKey":"browser.proxy.oneOf.0.id","typeLabel":"string"},"name":{"description":"Proxy name. Must match exactly one active proxy in the project.","minLength":1,"type":"string","uniqueKey":"browser.proxy.oneOf.0.name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"browser.proxy.oneOf.0","typeLabel":"object"},{"type":"object","description":"Proxy configuration for managed auth browser sessions. Omit on create to derive the default from stealth, or on update and login to preserve or inherit the connection default.","required":["id"],"properties":{"id":{"description":"Proxy ID.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"browser.proxy.oneOf.1.id","typeLabel":"string"},"mode":{"description":"Proxy egress mode. direct forces no proxy regardless of stealth. default uses the browser's stealth-derived default: Kernel's default stealth proxy when stealth=true, or direct egress when stealth=false.\ndefault is primarily useful on browser update to restore the browser default after selected-proxy egress.\n","enum":["direct","default"],"type":"string","x-enum-varnames":["Direct","Default"],"uniqueKey":"browser.proxy.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"name":{"description":"Proxy name. Must match exactly one active proxy in the project.","minLength":1,"type":"string","uniqueKey":"browser.proxy.oneOf.1.name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"browser.proxy.oneOf.1","typeLabel":"object"},{"type":"object","description":"Proxy configuration for managed auth browser sessions. Omit on create to derive the default from stealth, or on update and login to preserve or inherit the connection default.","required":["name"],"properties":{"name":{"description":"Proxy name. Must match exactly one active proxy in the project.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"browser.proxy.oneOf.2.name","typeLabel":"string"},"id":{"description":"Proxy ID.","minLength":1,"type":"string","uniqueKey":"browser.proxy.oneOf.2.id","typeLabel":"string"},"mode":{"description":"Proxy egress mode. direct forces no proxy regardless of stealth. default uses the browser's stealth-derived default: Kernel's default stealth proxy when stealth=true, or direct egress when stealth=false.\ndefault is primarily useful on browser update to restore the browser default after selected-proxy egress.\n","enum":["direct","default"],"type":"string","x-enum-varnames":["Direct","Default"],"uniqueKey":"browser.proxy.oneOf.2.mode","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"browser.proxy.oneOf.2","typeLabel":"object"}],"uniqueKey":"browser.proxy","typeLabel":"object"},"region":{"description":"Browser region. Omit on create to use us-east, on update to keep the current region, or on login to inherit it. Login overrides apply only to that login. Non-default regions require an eligible plan and organization access.\n","enum":["us-east","us-west","eu-west","ap-southeast"],"type":"string","uniqueKey":"browser.region","typeLabel":"enum\u003cstring>"},"stealth":{"description":"Whether managed auth browser sessions use stealth mode. Defaults to true when omitted.","example":false,"type":"boolean","uniqueKey":"browser.stealth","typeLabel":"boolean"},"telemetry":{"oneOf":[{"description":"Browser telemetry configuration using the same semantics as browser create.","properties":{"browser":{"description":"Per-category capture flags. The operational categories (control, connection, system, captcha) are captured whenever telemetry is enabled; set one to enabled=false to opt out. The CDP categories (console, network, page, interaction), screenshot and platform are off by default; set enabled=true to opt in. On create, provided categories layer onto the default set. On update, provided categories merge onto the session's current config; when no telemetry is active this falls back to the default set (matching create). If browser is omitted or empty, the default set is used. A browser config that disables every category stops capture on update and starts no capture on create.","properties":{"captcha":{"description":"Captcha solver tasks and visible challenge outcomes. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.captcha.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.captcha","typeLabel":"object"},"connection":{"description":"Client attach/detach lifecycle for the CDP proxy and live view. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.connection.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.connection","typeLabel":"object"},"console":{"description":"Console output (log, warn, error) and uncaught exceptions. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.console.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.console","typeLabel":"object"},"control":{"description":"Agent-driven actions against the browser — computer-control calls, Playwright code execution, screenshots, clipboard access, and browser-control commands sent over the CDP proxy. On by default.","properties":{"cdp":{"description":"Settings for the cdp_command events the CDP proxy reports. Merged independently of enabled, so a later update that only sets enabled keeps the current exclusion list.","properties":{"excluded_methods":{"description":"Methods to leave out of the cdp_command stream. Omit the list to keep the current one; send an empty list to report every supported method again. Exclusion is a telemetry setting only: an excluded command is still relayed to the browser unchanged, it simply produces no event. Use it to drop the highest-volume methods — Input.dispatchMouseEvent during a humanized cursor path, or Page.captureScreenshot under a screencast — without turning the whole category off. Excluded commands are counted in cdp_disconnect.telemetry_excluded.","items":{"description":"A browser-control CDP method the proxy reports. The set covers the commands an agent drives the browser with; configuration, DOM and Runtime bookkeeping, and Chrome-specific UI commands are outside it. Canonical definitions: devtools-protocol@2d019e73.\n","enum":["Input.dispatchMouseEvent","Input.dispatchKeyEvent","Input.insertText","Input.imeSetComposition","Input.dispatchTouchEvent","Input.dispatchDragEvent","Input.cancelDragging","Input.emulateTouchFromMouseEvent","Input.synthesizePinchGesture","Input.synthesizeScrollGesture","Input.synthesizeTapGesture","DOM.setFileInputFiles","DOM.focus","DOM.scrollIntoViewIfNeeded","Page.bringToFront","Page.captureScreenshot","Page.captureSnapshot","Page.handleJavaScriptDialog","Page.navigate","Page.navigateToHistoryEntry","Page.reload","Page.printToPDF","Page.startScreencast","Page.stopScreencast","Page.stopLoading","Page.close","Page.setWebLifecycleState","Target.activateTarget","Target.closeTarget","Target.createTarget","Target.createBrowserContext","Target.disposeBrowserContext","Target.openDevTools","Browser.cancelDownload","Browser.close","Browser.setWindowBounds","Browser.setContentsSize","Autofill.trigger"],"type":"string","uniqueKey":"browser.telemetry.oneOf.0.browser.control.cdp.excluded_methods.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"browser.telemetry.oneOf.0.browser.control.cdp.excluded_methods","typeLabel":"enum\u003cstring>[]"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.control.cdp","typeLabel":"object"},"enabled":{"description":"Whether this category is captured. Control is on by default; set false to opt out.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.control.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.control","typeLabel":"object"},"interaction":{"description":"User interaction events including clicks, keydowns, and scroll-settled events. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.interaction.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.interaction","typeLabel":"object"},"network":{"description":"HTTP request and response metadata including URL, method, status code, and timing. Request post data is forwarded as-is from CDP. Text response bodies are truncated at 8 KB for structured types (JSON, XML, form data) and 4 KB for other text types. Binary responses (images, fonts, media) are excluded. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.network.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.network","typeLabel":"object"},"page":{"description":"Page lifecycle events including navigation, DOMContentLoaded, load, layout shifts, and LCP. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.page.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.page","typeLabel":"object"},"platform":{"description":"In-VM API calls that manage the browser VM rather than drive the browser (recording, filesystem, process, telemetry and browser configuration). Mostly platform-induced; off by default and must be opted into.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.platform.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.platform","typeLabel":"object"},"screenshot":{"description":"Periodic base64-encoded viewport screenshots. High volume; off by default and must be opted into.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.screenshot.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.screenshot","typeLabel":"object"},"system":{"description":"Browser VM health, such as out-of-memory kills and managed-service crashes. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.browser.system.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser.system","typeLabel":"object"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.browser","typeLabel":"object"},"enabled":{"description":"Request shortcut for browser telemetry capture. True enables capture; with no browser category settings it captures the default set (control, connection, system, captcha), and any browser category settings are layered onto that default set. On update, enabled=true resolves the config fresh from the default set plus any provided categories, replacing the session's current selection rather than merging onto it; omit enabled to merge categories onto the current selection instead. False stops capture on update and starts no capture on create. enabled=false cannot be combined with browser category settings.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.enabled","typeLabel":"boolean"},"export":{"description":"Where to export this session's captured telemetry. Omit to capture without exporting.","properties":{"otlp":{"description":"Export captured telemetry over OTLP to one of the org's configured destinations.","properties":{"destination":{"oneOf":[{"type":"object","description":"OTLP destination to export this session's captured telemetry to. Provide either id or name. Requires telemetry capture to be enabled.","required":["id"],"properties":{"id":{"description":"OTLP destination ID","type":"string","isRequired":true,"uniqueKey":"browser.telemetry.oneOf.0.export.otlp.destination.oneOf.0.id","typeLabel":"string"},"name":{"description":"OTLP destination name","type":"string","uniqueKey":"browser.telemetry.oneOf.0.export.otlp.destination.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"browser.telemetry.oneOf.0.export.otlp.destination.oneOf.0","typeLabel":"object"},{"type":"object","description":"OTLP destination to export this session's captured telemetry to. Provide either id or name. Requires telemetry capture to be enabled.","required":["name"],"properties":{"name":{"description":"OTLP destination name","type":"string","isRequired":true,"uniqueKey":"browser.telemetry.oneOf.0.export.otlp.destination.oneOf.1.name","typeLabel":"string"},"id":{"description":"OTLP destination ID","type":"string","uniqueKey":"browser.telemetry.oneOf.0.export.otlp.destination.oneOf.1.id","typeLabel":"string"}},"uniqueKey":"browser.telemetry.oneOf.0.export.otlp.destination.oneOf.1","typeLabel":"object"}],"uniqueKey":"browser.telemetry.oneOf.0.export.otlp.destination","typeLabel":"object"},"enabled":{"description":"Whether to export captured telemetry over OTLP. Setting destination implies enabled=true, so this only needs to be set explicitly to disable export (enabled=false with a destination is rejected).","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.export.otlp.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.export.otlp","typeLabel":"object"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.export","typeLabel":"object"},"storage":{"description":"Whether to persist this session's captured telemetry to Kernel storage.","properties":{"enabled":{"description":"Whether captured telemetry is persisted to Kernel storage. Defaults to true. Setting false requires an OTLP destination and cannot be changed after the browser is created.","type":"boolean","uniqueKey":"browser.telemetry.oneOf.0.storage.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0.storage","typeLabel":"object"}},"type":"object","uniqueKey":"browser.telemetry.oneOf.0","typeLabel":"object"},{"description":"Browser telemetry configuration using the same semantics as browser create.","properties":{"browser":{"description":"Per-category capture flags. The operational categories (control, connection, system, captcha) are captured whenever telemetry is enabled; set one to enabled=false to opt out. The CDP categories (console, network, page, interaction), screenshot and platform are off by default; set enabled=true to opt in. On create, provided categories layer onto the default set. On update, provided categories merge onto the session's current config; when no telemetry is active this falls back to the default set (matching create). If browser is omitted or empty, the default set is used. A browser config that disables every category stops capture on update and starts no capture on create.","properties":{"captcha":{"description":"Captcha solver tasks and visible challenge outcomes. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"connection":{"description":"Client attach/detach lifecycle for the CDP proxy and live view. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"console":{"description":"Console output (log, warn, error) and uncaught exceptions. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"control":{"description":"Agent-driven actions against the browser — computer-control calls, Playwright code execution, screenshots, clipboard access, and browser-control commands sent over the CDP proxy. On by default.","properties":{"cdp":{"description":"Settings for the cdp_command events the CDP proxy reports. Merged independently of enabled, so a later update that only sets enabled keeps the current exclusion list.","properties":{"excluded_methods":{"description":"Methods to leave out of the cdp_command stream. Omit the list to keep the current one; send an empty list to report every supported method again. Exclusion is a telemetry setting only: an excluded command is still relayed to the browser unchanged, it simply produces no event. Use it to drop the highest-volume methods — Input.dispatchMouseEvent during a humanized cursor path, or Page.captureScreenshot under a screencast — without turning the whole category off. Excluded commands are counted in cdp_disconnect.telemetry_excluded.","items":{"description":"A browser-control CDP method the proxy reports. The set covers the commands an agent drives the browser with; configuration, DOM and Runtime bookkeeping, and Chrome-specific UI commands are outside it. Canonical definitions: devtools-protocol@2d019e73.\n","enum":["Input.dispatchMouseEvent","Input.dispatchKeyEvent","Input.insertText","Input.imeSetComposition","Input.dispatchTouchEvent","Input.dispatchDragEvent","Input.cancelDragging","Input.emulateTouchFromMouseEvent","Input.synthesizePinchGesture","Input.synthesizeScrollGesture","Input.synthesizeTapGesture","DOM.setFileInputFiles","DOM.focus","DOM.scrollIntoViewIfNeeded","Page.bringToFront","Page.captureScreenshot","Page.captureSnapshot","Page.handleJavaScriptDialog","Page.navigate","Page.navigateToHistoryEntry","Page.reload","Page.printToPDF","Page.startScreencast","Page.stopScreencast","Page.stopLoading","Page.close","Page.setWebLifecycleState","Target.activateTarget","Target.closeTarget","Target.createTarget","Target.createBrowserContext","Target.disposeBrowserContext","Target.openDevTools","Browser.cancelDownload","Browser.close","Browser.setWindowBounds","Browser.setContentsSize","Autofill.trigger"],"type":"string"},"type":"array"}},"type":"object"},"enabled":{"description":"Whether this category is captured. Control is on by default; set false to opt out.","type":"boolean"}},"type":"object"},"interaction":{"description":"User interaction events including clicks, keydowns, and scroll-settled events. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"network":{"description":"HTTP request and response metadata including URL, method, status code, and timing. Request post data is forwarded as-is from CDP. Text response bodies are truncated at 8 KB for structured types (JSON, XML, form data) and 4 KB for other text types. Binary responses (images, fonts, media) are excluded. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"page":{"description":"Page lifecycle events including navigation, DOMContentLoaded, load, layout shifts, and LCP. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"platform":{"description":"In-VM API calls that manage the browser VM rather than drive the browser (recording, filesystem, process, telemetry and browser configuration). Mostly platform-induced; off by default and must be opted into.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"screenshot":{"description":"Periodic base64-encoded viewport screenshots. High volume; off by default and must be opted into.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"system":{"description":"Browser VM health, such as out-of-memory kills and managed-service crashes. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"}},"type":"object"},"enabled":{"description":"Request shortcut for browser telemetry capture. True enables capture; with no browser category settings it captures the default set (control, connection, system, captcha), and any browser category settings are layered onto that default set. On update, enabled=true resolves the config fresh from the default set plus any provided categories, replacing the session's current selection rather than merging onto it; omit enabled to merge categories onto the current selection instead. False stops capture on update and starts no capture on create. enabled=false cannot be combined with browser category settings.","type":"boolean"},"export":{"description":"Where to export this session's captured telemetry. Omit to capture without exporting.","properties":{"otlp":{"description":"Export captured telemetry over OTLP to one of the org's configured destinations.","properties":{"destination":{"oneOf":[{"type":"object","description":"OTLP destination to export this session's captured telemetry to. Provide either id or name. Requires telemetry capture to be enabled.","required":["id"],"properties":{"id":{"description":"OTLP destination ID","type":"string"},"name":{"description":"OTLP destination name","type":"string"}}},{"type":"object","description":"OTLP destination to export this session's captured telemetry to. Provide either id or name. Requires telemetry capture to be enabled.","required":["name"],"properties":{"id":{"description":"OTLP destination ID","type":"string"},"name":{"description":"OTLP destination name","type":"string"}}}]},"enabled":{"description":"Whether to export captured telemetry over OTLP. Setting destination implies enabled=true, so this only needs to be set explicitly to disable export (enabled=false with a destination is rejected).","type":"boolean"}},"type":"object"}},"type":"object"},"storage":{"description":"Whether to persist this session's captured telemetry to Kernel storage.","properties":{"enabled":{"description":"Whether captured telemetry is persisted to Kernel storage. Defaults to true. Setting false requires an OTLP destination and cannot be changed after the browser is created.","type":"boolean"}},"type":"object"}},"type":"null","uniqueKey":"browser.telemetry.oneOf.1","typeLabel":"null"}],"uniqueKey":"browser.telemetry","typeLabel":"object | null"}},"type":"object","uniqueKey":"browser","typeLabel":"object"},"browser_telemetry":{"oneOf":[{"description":"Deprecated. Use browser.telemetry. Retained during migration for existing clients.","properties":{"browser":{"description":"Per-category capture flags. The operational categories (control, connection, system, captcha) are captured whenever telemetry is enabled; set one to enabled=false to opt out. The CDP categories (console, network, page, interaction), screenshot and platform are off by default; set enabled=true to opt in. On create, provided categories layer onto the default set. On update, provided categories merge onto the session's current config; when no telemetry is active this falls back to the default set (matching create). If browser is omitted or empty, the default set is used. A browser config that disables every category stops capture on update and starts no capture on create.","properties":{"captcha":{"description":"Captcha solver tasks and visible challenge outcomes. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.captcha.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.captcha","typeLabel":"object"},"connection":{"description":"Client attach/detach lifecycle for the CDP proxy and live view. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.connection.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.connection","typeLabel":"object"},"console":{"description":"Console output (log, warn, error) and uncaught exceptions. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.console.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.console","typeLabel":"object"},"control":{"description":"Agent-driven actions against the browser — computer-control calls, Playwright code execution, screenshots, clipboard access, and browser-control commands sent over the CDP proxy. On by default.","properties":{"cdp":{"description":"Settings for the cdp_command events the CDP proxy reports. Merged independently of enabled, so a later update that only sets enabled keeps the current exclusion list.","properties":{"excluded_methods":{"description":"Methods to leave out of the cdp_command stream. Omit the list to keep the current one; send an empty list to report every supported method again. Exclusion is a telemetry setting only: an excluded command is still relayed to the browser unchanged, it simply produces no event. Use it to drop the highest-volume methods — Input.dispatchMouseEvent during a humanized cursor path, or Page.captureScreenshot under a screencast — without turning the whole category off. Excluded commands are counted in cdp_disconnect.telemetry_excluded.","items":{"description":"A browser-control CDP method the proxy reports. The set covers the commands an agent drives the browser with; configuration, DOM and Runtime bookkeeping, and Chrome-specific UI commands are outside it. Canonical definitions: devtools-protocol@2d019e73.\n","enum":["Input.dispatchMouseEvent","Input.dispatchKeyEvent","Input.insertText","Input.imeSetComposition","Input.dispatchTouchEvent","Input.dispatchDragEvent","Input.cancelDragging","Input.emulateTouchFromMouseEvent","Input.synthesizePinchGesture","Input.synthesizeScrollGesture","Input.synthesizeTapGesture","DOM.setFileInputFiles","DOM.focus","DOM.scrollIntoViewIfNeeded","Page.bringToFront","Page.captureScreenshot","Page.captureSnapshot","Page.handleJavaScriptDialog","Page.navigate","Page.navigateToHistoryEntry","Page.reload","Page.printToPDF","Page.startScreencast","Page.stopScreencast","Page.stopLoading","Page.close","Page.setWebLifecycleState","Target.activateTarget","Target.closeTarget","Target.createTarget","Target.createBrowserContext","Target.disposeBrowserContext","Target.openDevTools","Browser.cancelDownload","Browser.close","Browser.setWindowBounds","Browser.setContentsSize","Autofill.trigger"],"type":"string","uniqueKey":"browser_telemetry.oneOf.0.browser.control.cdp.excluded_methods.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"browser_telemetry.oneOf.0.browser.control.cdp.excluded_methods","typeLabel":"enum\u003cstring>[]"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.control.cdp","typeLabel":"object"},"enabled":{"description":"Whether this category is captured. Control is on by default; set false to opt out.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.control.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.control","typeLabel":"object"},"interaction":{"description":"User interaction events including clicks, keydowns, and scroll-settled events. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.interaction.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.interaction","typeLabel":"object"},"network":{"description":"HTTP request and response metadata including URL, method, status code, and timing. Request post data is forwarded as-is from CDP. Text response bodies are truncated at 8 KB for structured types (JSON, XML, form data) and 4 KB for other text types. Binary responses (images, fonts, media) are excluded. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.network.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.network","typeLabel":"object"},"page":{"description":"Page lifecycle events including navigation, DOMContentLoaded, load, layout shifts, and LCP. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.page.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.page","typeLabel":"object"},"platform":{"description":"In-VM API calls that manage the browser VM rather than drive the browser (recording, filesystem, process, telemetry and browser configuration). Mostly platform-induced; off by default and must be opted into.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.platform.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.platform","typeLabel":"object"},"screenshot":{"description":"Periodic base64-encoded viewport screenshots. High volume; off by default and must be opted into.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.screenshot.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.screenshot","typeLabel":"object"},"system":{"description":"Browser VM health, such as out-of-memory kills and managed-service crashes. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.browser.system.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser.system","typeLabel":"object"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.browser","typeLabel":"object"},"enabled":{"description":"Request shortcut for browser telemetry capture. True enables capture; with no browser category settings it captures the default set (control, connection, system, captcha), and any browser category settings are layered onto that default set. On update, enabled=true resolves the config fresh from the default set plus any provided categories, replacing the session's current selection rather than merging onto it; omit enabled to merge categories onto the current selection instead. False stops capture on update and starts no capture on create. enabled=false cannot be combined with browser category settings.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.enabled","typeLabel":"boolean"},"export":{"description":"Where to export this session's captured telemetry. Omit to capture without exporting.","properties":{"otlp":{"description":"Export captured telemetry over OTLP to one of the org's configured destinations.","properties":{"destination":{"oneOf":[{"type":"object","description":"OTLP destination to export this session's captured telemetry to. Provide either id or name. Requires telemetry capture to be enabled.","required":["id"],"properties":{"id":{"description":"OTLP destination ID","type":"string","isRequired":true,"uniqueKey":"browser_telemetry.oneOf.0.export.otlp.destination.oneOf.0.id","typeLabel":"string"},"name":{"description":"OTLP destination name","type":"string","uniqueKey":"browser_telemetry.oneOf.0.export.otlp.destination.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"browser_telemetry.oneOf.0.export.otlp.destination.oneOf.0","typeLabel":"object"},{"type":"object","description":"OTLP destination to export this session's captured telemetry to. Provide either id or name. Requires telemetry capture to be enabled.","required":["name"],"properties":{"name":{"description":"OTLP destination name","type":"string","isRequired":true,"uniqueKey":"browser_telemetry.oneOf.0.export.otlp.destination.oneOf.1.name","typeLabel":"string"},"id":{"description":"OTLP destination ID","type":"string","uniqueKey":"browser_telemetry.oneOf.0.export.otlp.destination.oneOf.1.id","typeLabel":"string"}},"uniqueKey":"browser_telemetry.oneOf.0.export.otlp.destination.oneOf.1","typeLabel":"object"}],"uniqueKey":"browser_telemetry.oneOf.0.export.otlp.destination","typeLabel":"object"},"enabled":{"description":"Whether to export captured telemetry over OTLP. Setting destination implies enabled=true, so this only needs to be set explicitly to disable export (enabled=false with a destination is rejected).","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.export.otlp.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.export.otlp","typeLabel":"object"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.export","typeLabel":"object"},"storage":{"description":"Whether to persist this session's captured telemetry to Kernel storage.","properties":{"enabled":{"description":"Whether captured telemetry is persisted to Kernel storage. Defaults to true. Setting false requires an OTLP destination and cannot be changed after the browser is created.","type":"boolean","uniqueKey":"browser_telemetry.oneOf.0.storage.enabled","typeLabel":"boolean"}},"type":"object","uniqueKey":"browser_telemetry.oneOf.0.storage","typeLabel":"object"}},"type":"object","deprecated":true,"uniqueKey":"browser_telemetry.oneOf.0","typeLabel":"object"},{"description":"Deprecated. Use browser.telemetry. Retained during migration for existing clients.","properties":{"browser":{"description":"Per-category capture flags. The operational categories (control, connection, system, captcha) are captured whenever telemetry is enabled; set one to enabled=false to opt out. The CDP categories (console, network, page, interaction), screenshot and platform are off by default; set enabled=true to opt in. On create, provided categories layer onto the default set. On update, provided categories merge onto the session's current config; when no telemetry is active this falls back to the default set (matching create). If browser is omitted or empty, the default set is used. A browser config that disables every category stops capture on update and starts no capture on create.","properties":{"captcha":{"description":"Captcha solver tasks and visible challenge outcomes. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"connection":{"description":"Client attach/detach lifecycle for the CDP proxy and live view. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"console":{"description":"Console output (log, warn, error) and uncaught exceptions. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"control":{"description":"Agent-driven actions against the browser — computer-control calls, Playwright code execution, screenshots, clipboard access, and browser-control commands sent over the CDP proxy. On by default.","properties":{"cdp":{"description":"Settings for the cdp_command events the CDP proxy reports. Merged independently of enabled, so a later update that only sets enabled keeps the current exclusion list.","properties":{"excluded_methods":{"description":"Methods to leave out of the cdp_command stream. Omit the list to keep the current one; send an empty list to report every supported method again. Exclusion is a telemetry setting only: an excluded command is still relayed to the browser unchanged, it simply produces no event. Use it to drop the highest-volume methods — Input.dispatchMouseEvent during a humanized cursor path, or Page.captureScreenshot under a screencast — without turning the whole category off. Excluded commands are counted in cdp_disconnect.telemetry_excluded.","items":{"description":"A browser-control CDP method the proxy reports. The set covers the commands an agent drives the browser with; configuration, DOM and Runtime bookkeeping, and Chrome-specific UI commands are outside it. Canonical definitions: devtools-protocol@2d019e73.\n","enum":["Input.dispatchMouseEvent","Input.dispatchKeyEvent","Input.insertText","Input.imeSetComposition","Input.dispatchTouchEvent","Input.dispatchDragEvent","Input.cancelDragging","Input.emulateTouchFromMouseEvent","Input.synthesizePinchGesture","Input.synthesizeScrollGesture","Input.synthesizeTapGesture","DOM.setFileInputFiles","DOM.focus","DOM.scrollIntoViewIfNeeded","Page.bringToFront","Page.captureScreenshot","Page.captureSnapshot","Page.handleJavaScriptDialog","Page.navigate","Page.navigateToHistoryEntry","Page.reload","Page.printToPDF","Page.startScreencast","Page.stopScreencast","Page.stopLoading","Page.close","Page.setWebLifecycleState","Target.activateTarget","Target.closeTarget","Target.createTarget","Target.createBrowserContext","Target.disposeBrowserContext","Target.openDevTools","Browser.cancelDownload","Browser.close","Browser.setWindowBounds","Browser.setContentsSize","Autofill.trigger"],"type":"string"},"type":"array"}},"type":"object"},"enabled":{"description":"Whether this category is captured. Control is on by default; set false to opt out.","type":"boolean"}},"type":"object"},"interaction":{"description":"User interaction events including clicks, keydowns, and scroll-settled events. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"network":{"description":"HTTP request and response metadata including URL, method, status code, and timing. Request post data is forwarded as-is from CDP. Text response bodies are truncated at 8 KB for structured types (JSON, XML, form data) and 4 KB for other text types. Binary responses (images, fonts, media) are excluded. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"page":{"description":"Page lifecycle events including navigation, DOMContentLoaded, load, layout shifts, and LCP. CDP category; off by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"platform":{"description":"In-VM API calls that manage the browser VM rather than drive the browser (recording, filesystem, process, telemetry and browser configuration). Mostly platform-induced; off by default and must be opted into.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"screenshot":{"description":"Periodic base64-encoded viewport screenshots. High volume; off by default and must be opted into.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"},"system":{"description":"Browser VM health, such as out-of-memory kills and managed-service crashes. On by default.","properties":{"enabled":{"description":"Whether this category is captured. Operational categories (control, connection, system, captcha) default to true; set false to opt out. CDP categories (console, network, page, interaction), screenshot and platform default to false; set true to opt in.","type":"boolean"}},"type":"object"}},"type":"object"},"enabled":{"description":"Request shortcut for browser telemetry capture. True enables capture; with no browser category settings it captures the default set (control, connection, system, captcha), and any browser category settings are layered onto that default set. On update, enabled=true resolves the config fresh from the default set plus any provided categories, replacing the session's current selection rather than merging onto it; omit enabled to merge categories onto the current selection instead. False stops capture on update and starts no capture on create. enabled=false cannot be combined with browser category settings.","type":"boolean"},"export":{"description":"Where to export this session's captured telemetry. Omit to capture without exporting.","properties":{"otlp":{"description":"Export captured telemetry over OTLP to one of the org's configured destinations.","properties":{"destination":{"oneOf":[{"type":"object","description":"OTLP destination to export this session's captured telemetry to. Provide either id or name. Requires telemetry capture to be enabled.","required":["id"],"properties":{"id":{"description":"OTLP destination ID","type":"string"},"name":{"description":"OTLP destination name","type":"string"}}},{"type":"object","description":"OTLP destination to export this session's captured telemetry to. Provide either id or name. Requires telemetry capture to be enabled.","required":["name"],"properties":{"id":{"description":"OTLP destination ID","type":"string"},"name":{"description":"OTLP destination name","type":"string"}}}]},"enabled":{"description":"Whether to export captured telemetry over OTLP. Setting destination implies enabled=true, so this only needs to be set explicitly to disable export (enabled=false with a destination is rejected).","type":"boolean"}},"type":"object"}},"type":"object"},"storage":{"description":"Whether to persist this session's captured telemetry to Kernel storage.","properties":{"enabled":{"description":"Whether captured telemetry is persisted to Kernel storage. Defaults to true. Setting false requires an OTLP destination and cannot be changed after the browser is created.","type":"boolean"}},"type":"object"}},"type":"null","deprecated":true,"uniqueKey":"browser_telemetry.oneOf.1","typeLabel":"null"}],"uniqueKey":"browser_telemetry","typeLabel":"object | null"},"proxy":{"oneOf":[{"type":"object","description":"Deprecated. Use browser.proxy. Retained during migration for existing clients.","required":["id"],"deprecated":true,"properties":{"id":{"description":"Proxy ID","type":"string","isRequired":true,"uniqueKey":"proxy.oneOf.0.id","typeLabel":"string"},"name":{"description":"Proxy name","type":"string","uniqueKey":"proxy.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"proxy.oneOf.0","typeLabel":"object"},{"type":"object","description":"Deprecated. Use browser.proxy. Retained during migration for existing clients.","required":["name"],"deprecated":true,"properties":{"name":{"description":"Proxy name","type":"string","isRequired":true,"uniqueKey":"proxy.oneOf.1.name","typeLabel":"string"},"id":{"description":"Proxy ID","type":"string","uniqueKey":"proxy.oneOf.1.id","typeLabel":"string"}},"uniqueKey":"proxy.oneOf.1","typeLabel":"object"}],"uniqueKey":"proxy","typeLabel":"object"},"record_session":{"description":"Override the connection's default for recording this login's browser session. When omitted, the connection's record_session default is used.","example":true,"type":"boolean","uniqueKey":"record_session","typeLabel":"boolean"},"skill_mode":{"description":"Controls whether this login reads and writes learned domain skills. Automatic reauths inherit the selected mode until a later accepted login sets enabled or omits this field. Defaults to enabled when omitted.","enum":["enabled","disabled"],"type":"string","x-enum-varnames":["LoginRequestSkillModeEnabled","LoginRequestSkillModeDisabled"],"uniqueKey":"skill_mode","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"browser":{"proxy":{"id":"\u003cstring>","name":"\u003cstring>"},"stealth":false,"telemetry":{"browser":{"captcha":{"enabled":true},"connection":{"enabled":true},"console":{"enabled":true},"control":{"cdp":{"excluded_methods":[]},"enabled":true},"interaction":{"enabled":true},"network":{"enabled":true},"page":{"enabled":true},"platform":{"enabled":true},"screenshot":{"enabled":true},"system":{"enabled":true}},"enabled":true,"export":{"otlp":{"destination":{"id":"\u003cstring>","name":"\u003cstring>"},"enabled":true}},"storage":{"enabled":true}}},"browser_telemetry":{"browser":{"captcha":{"enabled":true},"connection":{"enabled":true},"console":{"enabled":true},"control":{"cdp":{"excluded_methods":[]},"enabled":true},"interaction":{"enabled":true},"network":{"enabled":true},"page":{"enabled":true},"platform":{"enabled":true},"screenshot":{"enabled":true},"system":{"enabled":true}},"enabled":true,"export":{"otlp":{"destination":{"id":"\u003cstring>","name":"\u003cstring>"},"enabled":true}},"storage":{"enabled":true}},"proxy":{"id":"\u003cstring>","name":"\u003cstring>"},"record_session":true}}},"exampleType":"generated"}},"required":false,"exampleType":"generated"},"responses":{"f556ce9e-e180-46f8-9ed1-23443213f7c9":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Response from starting a login flow","properties":{"flow_expires_at":{"description":"When the login flow expires","example":"2025-11-05T20:00:00Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"flow_expires_at","typeLabel":"string\u003cdate-time>"},"flow_type":{"description":"Type of login flow started","enum":["LOGIN","REAUTH"],"example":"LOGIN","type":"string","isRequired":true,"uniqueKey":"flow_type","typeLabel":"enum\u003cstring>"},"hosted_url":{"description":"URL to redirect user to for login","example":"https://auth.kernel.com/login/abc123xyz","format":"uri","type":"string","isRequired":true,"uniqueKey":"hosted_url","typeLabel":"string\u003curi>"},"id":{"description":"Auth connection ID","example":"ma_abc123xyz","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"handoff_code":{"description":"One-time code for handoff (internal use)","example":"aBcD123EfGh456IjKl789MnOp012QrStUvWxYzAbCdEf","type":"string","uniqueKey":"handoff_code","typeLabel":"string"},"live_view_url":{"description":"Browser live view URL for watching the login flow","example":"https://live.onkernel.com/abc123xyz","format":"uri","type":"string","uniqueKey":"live_view_url","typeLabel":"string\u003curi>"}},"required":["id","flow_type","hosted_url","flow_expires_at"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"flow_expires_at":"2025-11-05T20:00:00Z","flow_type":"LOGIN","hosted_url":"https://auth.kernel.com/login/abc123xyz","id":"ma_abc123xyz","handoff_code":"aBcD123EfGh456IjKl789MnOp012QrStUvWxYzAbCdEf","live_view_url":"https://live.onkernel.com/abc123xyz"}}},"exampleType":"generated"}},"description":"Login flow started","exampleType":"generated"},"a18ebb9a-00ea-494e-81be-34e2830803ba":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Application-specific error code (machine-readable)","example":"bad_request","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"Human-readable error description for debugging","example":"Missing required field: app_name","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional error details (for multiple errors)","items":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"details","typeLabel":"object[]"},"inner_error":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"inner_error.code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"inner_error.message","typeLabel":"string"}},"type":"object","uniqueKey":"inner_error","typeLabel":"object"}},"required":["code","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"bad_request","message":"Missing required field: app_name","details":[{"code":"invalid_input","message":"Provided version string is not semver compliant"}],"inner_error":{"code":"invalid_input","message":"Provided version string is not semver compliant"}}}},"exampleType":"generated"}},"description":"Bad Request – invalid input","exampleType":"generated"},"84f55d16-3246-43df-9c9b-b067e4ba5e9b":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Application-specific error code (machine-readable)","example":"bad_request","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"Human-readable error description for debugging","example":"Missing required field: app_name","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional error details (for multiple errors)","items":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"details","typeLabel":"object[]"},"inner_error":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"inner_error.code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"inner_error.message","typeLabel":"string"}},"type":"object","uniqueKey":"inner_error","typeLabel":"object"}},"required":["code","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"bad_request","message":"Missing required field: app_name","details":[{"code":"invalid_input","message":"Provided version string is not semver compliant"}],"inner_error":{"code":"invalid_input","message":"Provided version string is not semver compliant"}}}},"exampleType":"generated"}},"description":"Unauthorized – missing or invalid authorization token","exampleType":"generated"},"288c1b2f-aad2-48b0-b0fc-d9715dae6ad1":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Application-specific error code (machine-readable)","example":"bad_request","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"Human-readable error description for debugging","example":"Missing required field: app_name","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional error details (for multiple errors)","items":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"details","typeLabel":"object[]"},"inner_error":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"inner_error.code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"inner_error.message","typeLabel":"string"}},"type":"object","uniqueKey":"inner_error","typeLabel":"object"}},"required":["code","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"bad_request","message":"Missing required field: app_name","details":[{"code":"invalid_input","message":"Provided version string is not semver compliant"}],"inner_error":{"code":"invalid_input","message":"Provided version string is not semver compliant"}}}},"exampleType":"generated"}},"description":"Forbidden – insufficient permissions or plan","exampleType":"generated"},"0f2fccc8-02f9-4ea3-b888-63af6d91b26f":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Application-specific error code (machine-readable)","example":"bad_request","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"Human-readable error description for debugging","example":"Missing required field: app_name","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional error details (for multiple errors)","items":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"details","typeLabel":"object[]"},"inner_error":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"inner_error.code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"inner_error.message","typeLabel":"string"}},"type":"object","uniqueKey":"inner_error","typeLabel":"object"}},"required":["code","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"bad_request","message":"Missing required field: app_name","details":[{"code":"invalid_input","message":"Provided version string is not semver compliant"}],"inner_error":{"code":"invalid_input","message":"Provided version string is not semver compliant"}}}},"exampleType":"generated"}},"description":"Resource not found","exampleType":"generated"},"ba83dcfb-8305-4d8f-b0e6-f3fc6b28b6ed":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Application-specific error code (machine-readable)","example":"bad_request","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"Human-readable error description for debugging","example":"Missing required field: app_name","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional error details (for multiple errors)","items":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"details","typeLabel":"object[]"},"inner_error":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"inner_error.code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"inner_error.message","typeLabel":"string"}},"type":"object","uniqueKey":"inner_error","typeLabel":"object"}},"required":["code","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"bad_request","message":"Missing required field: app_name","details":[{"code":"invalid_input","message":"Provided version string is not semver compliant"}],"inner_error":{"code":"invalid_input","message":"Provided version string is not semver compliant"}}}},"exampleType":"generated"}},"description":"Login flow already in progress","exampleType":"generated"},"6a1b3b55-33a5-4c0f-986f-cba9290b607b":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Application-specific error code (machine-readable)","example":"bad_request","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"description":"Human-readable error description for debugging","example":"Missing required field: app_name","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional error details (for multiple errors)","items":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"details","typeLabel":"object[]"},"inner_error":{"properties":{"code":{"description":"Lower-level error code providing more specific detail","example":"invalid_input","type":"string","uniqueKey":"inner_error.code","typeLabel":"string"},"message":{"description":"Further detail about the error","example":"Provided version string is not semver compliant","type":"string","uniqueKey":"inner_error.message","typeLabel":"string"}},"type":"object","uniqueKey":"inner_error","typeLabel":"object"}},"required":["code","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"bad_request","message":"Missing required field: app_name","details":[{"code":"invalid_input","message":"Provided version string is not semver compliant"}],"inner_error":{"code":"invalid_input","message":"Provided version string is not semver compliant"}}}},"exampleType":"generated"}},"description":"Internal Server Error","exampleType":"generated"}},"security":{"ec0b8db4-dd2c-4afc-8196-0c375c3ccc9e":{"bearerAuth":{"scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"334ce7c4-2851-4bdf-a5c8-e2a3ff581b12":{"description":"API Server","url":"https://api.onkernel.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.onkernel.com/spec.json"},"subdomain":"tbd-6fc993ce","siteName":"Kernel","title":"Start login flow - Kernel","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T05:50:28.527Z","originalFileLocation":"api-reference/managed-auth/start-login-flow.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kernel\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start login flow - Kernel\">\u003cmeta data-mint-head property=\"og:description\" content=\"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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kernel\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://www.kernel.sh/docs/images/og-image.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Start login flow - Kernel\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://www.kernel.sh/docs/images/og-image.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/tbd-6fc993ce/CjCJZGCXnaix-Ex0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kernel\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#212225\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/managed-auth/start-login-flow.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.kernel.sh/#organization\",\"name\":\"Kernel\",\"url\":\"https://www.kernel.sh\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tbd-6fc993ce/Lt3m2NlMiCztMtQK/logo/black.svg?fit=max\u0026auto=format\u0026n=Lt3m2NlMiCztMtQK\u0026q=85\u0026s=68e987c751954bbc1d35886a02636c73\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.kernel.sh/docs#website\",\"name\":\"Kernel\",\"url\":\"https://www.kernel.sh/docs\",\"publisher\":{\"@id\":\"https://www.kernel.sh/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow#webpage\",\"url\":\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow\",\"name\":\"Start login flow\",\"description\":\"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.\",\"dateModified\":\"2026-10-30T05:50:28.527Z\",\"isPartOf\":{\"@id\":\"https://www.kernel.sh/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Managed Auth\",\"item\":\"https://www.kernel.sh/docs/api-reference/managed-auth/list-auth-connections\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start login flow\",\"item\":\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow#apireference\",\"headline\":\"Start login flow\",\"name\":\"Start login flow\",\"description\":\"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.\",\"url\":\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow\",\"mainEntityOfPage\":{\"@id\":\"https://www.kernel.sh/docs/api-reference/managed-auth/start-login-flow#webpage\"},\"image\":\"https://www.kernel.sh/docs/images/og-image.png\",\"dateModified\":\"2026-10-30T05:50:28.527Z\",\"publisher\":{\"@id\":\"https://www.kernel.sh/#organization\"},\"isPartOf\":{\"@id\":\"https://www.kernel.sh/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kernel\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kernel","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Apps","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /apps","href":"/api-reference/apps/list-apps"}]},{"group":"Audit Logs","pages":[{"title":"List audit logs","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /audit-logs","href":"/api-reference/audit-logs/list-audit-logs"},{"title":"Download an audit-log export chunk","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /audit-logs/export/chunk","href":"/api-reference/audit-logs/download-an-audit-log-export-chunk"},{"title":"List audit log export destinations","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /audit-logs/export/destinations","href":"/api-reference/audit-logs/list-audit-log-export-destinations"},{"title":"Create an audit log export destination","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /audit-logs/export/destinations","href":"/api-reference/audit-logs/create-an-audit-log-export-destination"},{"title":"Retrieve an audit log export destination","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /audit-logs/export/destinations/{id}","href":"/api-reference/audit-logs/retrieve-an-audit-log-export-destination"},{"title":"Delete an audit log export destination","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /audit-logs/export/destinations/{id}","href":"/api-reference/audit-logs/delete-an-audit-log-export-destination"},{"title":"Update an audit log export destination","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /audit-logs/export/destinations/{id}","href":"/api-reference/audit-logs/update-an-audit-log-export-destination"},{"title":"Test an audit log export destination","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /audit-logs/export/destinations/{id}/test","href":"/api-reference/audit-logs/test-an-audit-log-export-destination"}]},{"group":"Managed Auth","pages":[{"title":"List auth connections","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /auth/connections","href":"/api-reference/managed-auth/list-auth-connections"},{"title":"Create auth connection","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /auth/connections","href":"/api-reference/managed-auth/create-auth-connection"},{"title":"Get auth connection","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /auth/connections/{id}","href":"/api-reference/managed-auth/get-auth-connection"},{"title":"Delete auth connection","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /auth/connections/{id}","href":"/api-reference/managed-auth/delete-auth-connection"},{"title":"Update auth connection","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /auth/connections/{id}","href":"/api-reference/managed-auth/update-auth-connection"},{"title":"Stream login flow events via SSE","description":"Establishes a Server-Sent Events (SSE) stream that delivers real-time\nlogin flow state updates. The stream terminates automatically once\nthe flow reaches a terminal state (SUCCESS, FAILED, EXPIRED, CANCELED).\n","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /auth/connections/{id}/events","href":"/api-reference/managed-auth/stream-login-flow-events-via-sse"},{"title":"Start login flow","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /auth/connections/{id}/login","href":"/api-reference/managed-auth/start-login-flow"},{"title":"Submit field values","description":"Submits field values for the login form. Poll the auth connection to track progress and get results.","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /auth/connections/{id}/submit","href":"/api-reference/managed-auth/submit-field-values"},{"title":"Get auth connection event timeline","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /auth/connections/{id}/timeline","href":"/api-reference/managed-auth/get-auth-connection-event-timeline"}]},{"group":"Authentication","pages":[{"title":"Get authentication context","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /auth/context","href":"/api-reference/authentication/get-authentication-context"}]},{"group":"Browser Pools","pages":[{"title":"List browser pools","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browser_pools","href":"/api-reference/browser-pools/list-browser-pools"},{"title":"Create a browser pool","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browser_pools","href":"/api-reference/browser-pools/create-a-browser-pool"},{"title":"Get browser pool details","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browser_pools/{id_or_name}","href":"/api-reference/browser-pools/get-browser-pool-details"},{"title":"Delete a browser pool","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /browser_pools/{id_or_name}","href":"/api-reference/browser-pools/delete-a-browser-pool"},{"title":"Update a browser pool","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /browser_pools/{id_or_name}","href":"/api-reference/browser-pools/update-a-browser-pool"},{"title":"Acquire a browser from the pool","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browser_pools/{id_or_name}/acquire","href":"/api-reference/browser-pools/acquire-a-browser-from-the-pool"},{"title":"Flush all idle browsers in the pool","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browser_pools/{id_or_name}/flush","href":"/api-reference/browser-pools/flush-all-idle-browsers-in-the-pool"},{"title":"Release a browser back to the pool","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browser_pools/{id_or_name}/release","href":"/api-reference/browser-pools/release-a-browser-back-to-the-pool"}]},{"group":"Browsers","pages":[{"title":"List browser sessions","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers","href":"/api-reference/browsers/list-browser-sessions"},{"title":"Create a browser session","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers","href":"/api-reference/browsers/create-a-browser-session"},{"title":"Get browser session details","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}","href":"/api-reference/browsers/get-browser-session-details"},{"title":"Delete a browser session by ID or name.","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /browsers/{id_or_name}","href":"/api-reference/browsers/delete-a-browser-session-by-id-or-name"},{"title":"Update browser session","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /browsers/{id_or_name}","href":"/api-reference/browsers/update-browser-session"},{"title":"Make an HTTP request through the browser's network stack","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/curl","href":"/api-reference/browsers/make-an-http-request-through-the-browsers-network-stack"},{"title":"Ad-hoc upload one or more unpacked extensions to a running browser instance.","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/extensions","href":"/api-reference/browsers/ad-hoc-upload-one-or-more-unpacked-extensions-to-a-running-browser-instance"},{"title":"Save the current browser state to a profile","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/profiles","href":"/api-reference/browsers/save-the-current-browser-state-to-a-profile"}]},{"group":"Browser Computer Controls","pages":[{"title":"Execute a batch of computer actions sequentially","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/batch","href":"/api-reference/browser-computer-controls/execute-a-batch-of-computer-actions-sequentially"},{"title":"Simulate a mouse click action on the browser instance","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/click_mouse","href":"/api-reference/browser-computer-controls/simulate-a-mouse-click-action-on-the-browser-instance"},{"title":"Read text from the clipboard on the browser instance","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/clipboard/read","href":"/api-reference/browser-computer-controls/read-text-from-the-clipboard-on-the-browser-instance"},{"title":"Write text to the clipboard on the browser instance","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/clipboard/write","href":"/api-reference/browser-computer-controls/write-text-to-the-clipboard-on-the-browser-instance"},{"title":"Set cursor visibility","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/cursor","href":"/api-reference/browser-computer-controls/set-cursor-visibility"},{"title":"Drag the mouse along a path","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/drag_mouse","href":"/api-reference/browser-computer-controls/drag-the-mouse-along-a-path"},{"title":"Get the current mouse cursor position on the browser instance","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/get_mouse_position","href":"/api-reference/browser-computer-controls/get-the-current-mouse-cursor-position-on-the-browser-instance"},{"title":"Move the mouse cursor to the specified coordinates on the browser instance","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/move_mouse","href":"/api-reference/browser-computer-controls/move-the-mouse-cursor-to-the-specified-coordinates-on-the-browser-instance"},{"title":"Press one or more keys on the host computer","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/press_key","href":"/api-reference/browser-computer-controls/press-one-or-more-keys-on-the-host-computer"},{"title":"Capture a screenshot of the browser instance","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/screenshot","href":"/api-reference/browser-computer-controls/capture-a-screenshot-of-the-browser-instance"},{"title":"Scroll the mouse wheel at a position on the host computer","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/scroll","href":"/api-reference/browser-computer-controls/scroll-the-mouse-wheel-at-a-position-on-the-host-computer"},{"title":"Type text on the browser instance","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/computer/type","href":"/api-reference/browser-computer-controls/type-text-on-the-browser-instance"}]},{"group":"Browser Filesystem","pages":[{"title":"Create a new directory","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json put /browsers/{id_or_name}/fs/create_directory","href":"/api-reference/browser-filesystem/create-a-new-directory"},{"title":"Delete a directory","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json put /browsers/{id_or_name}/fs/delete_directory","href":"/api-reference/browser-filesystem/delete-a-directory"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json put /browsers/{id_or_name}/fs/delete_file","href":"/api-reference/browser-filesystem/delete-a-file"},{"title":"Download a directory as a ZIP archive","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/fs/download_dir_zip","href":"/api-reference/browser-filesystem/download-a-directory-as-a-zip-archive"},{"title":"Get information about a file or directory","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/fs/file_info","href":"/api-reference/browser-filesystem/get-information-about-a-file-or-directory"},{"title":"List files in a directory","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/fs/list_files","href":"/api-reference/browser-filesystem/list-files-in-a-directory"},{"title":"Move or rename a file or directory","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json put /browsers/{id_or_name}/fs/move","href":"/api-reference/browser-filesystem/move-or-rename-a-file-or-directory"},{"title":"Read file contents","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/fs/read_file","href":"/api-reference/browser-filesystem/read-file-contents"},{"title":"Set file or directory permissions/ownership","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json put /browsers/{id_or_name}/fs/set_file_permissions","href":"/api-reference/browser-filesystem/set-file-or-directory-permissionsownership"},{"title":"Upload one or more files","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/fs/upload","href":"/api-reference/browser-filesystem/upload-one-or-more-files"},{"title":"Upload a zip archive and extract it","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/fs/upload_zip","href":"/api-reference/browser-filesystem/upload-a-zip-archive-and-extract-it"},{"title":"Watch a directory for changes","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/fs/watch","href":"/api-reference/browser-filesystem/watch-a-directory-for-changes"},{"title":"Stop watching a directory","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /browsers/{id_or_name}/fs/watch/{watch_id}","href":"/api-reference/browser-filesystem/stop-watching-a-directory"},{"title":"Stream filesystem events for a watch","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/fs/watch/{watch_id}/events","href":"/api-reference/browser-filesystem/stream-filesystem-events-for-a-watch"},{"title":"Write or create a file","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json put /browsers/{id_or_name}/fs/write_file","href":"/api-reference/browser-filesystem/write-or-create-a-file"}]},{"group":"Browser Logs","pages":[{"title":"Stream log files on the browser instance via SSE","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/logs/stream","href":"/api-reference/browser-logs/stream-log-files-on-the-browser-instance-via-sse"}]},{"group":"Browser Playwright","pages":[{"title":"Execute Playwright/TypeScript code against the browser","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/playwright/execute","href":"/api-reference/browser-playwright/execute-playwrighttypescript-code-against-the-browser"},{"title":"List Playwright executors","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/playwright/executors","href":"/api-reference/browser-playwright/list-playwright-executors"},{"title":"Delete a Playwright executor","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /browsers/{id_or_name}/playwright/executors/{name}","href":"/api-reference/browser-playwright/delete-a-playwright-executor"}]},{"group":"Browser Processes","pages":[{"title":"Execute a command synchronously","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/process/exec","href":"/api-reference/browser-processes/execute-a-command-synchronously"},{"title":"Execute a command asynchronously","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/process/spawn","href":"/api-reference/browser-processes/execute-a-command-asynchronously"},{"title":"Send signal to process","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/process/{process_id}/kill","href":"/api-reference/browser-processes/send-signal-to-process"},{"title":"Resize a PTY-backed process terminal","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/process/{process_id}/resize","href":"/api-reference/browser-processes/resize-a-pty-backed-process-terminal"},{"title":"Get process status","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/process/{process_id}/status","href":"/api-reference/browser-processes/get-process-status"},{"title":"Write to process stdin","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/process/{process_id}/stdin","href":"/api-reference/browser-processes/write-to-process-stdin"},{"title":"Stream process stdout via SSE","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/process/{process_id}/stdout/stream","href":"/api-reference/browser-processes/stream-process-stdout-via-sse"}]},{"group":"Browser REPL","pages":[{"title":"Execute JavaScript in the persistent Browser REPL","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/repl","href":"/api-reference/browser-repl/execute-javascript-in-the-persistent-browser-repl"}]},{"group":"Browser Replays","pages":[{"title":"List browser session replays","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/replays","href":"/api-reference/browser-replays/list-browser-session-replays"},{"title":"Start a browser session replay recording","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/replays","href":"/api-reference/browser-replays/start-a-browser-session-replay-recording"},{"title":"Download a replay recording","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/replays/{replay_id}","href":"/api-reference/browser-replays/download-a-replay-recording"},{"title":"Stop a browser session replay recording","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/replays/{replay_id}/stop","href":"/api-reference/browser-replays/stop-a-browser-session-replay-recording"}]},{"group":"Browser Telemetry","pages":[{"title":"Read telemetry events for a browser session","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/telemetry/events","href":"/api-reference/browser-telemetry/read-telemetry-events-for-a-browser-session"},{"title":"Stream telemetry events via SSE","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/telemetry/stream","href":"/api-reference/browser-telemetry/stream-telemetry-events-via-sse"},{"title":"List OTLP destinations","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /telemetry/destinations","href":"/api-reference/browser-telemetry/list-otlp-destinations"},{"title":"Create an OTLP destination","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /telemetry/destinations","href":"/api-reference/browser-telemetry/create-an-otlp-destination"},{"title":"Get OTLP destination by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /telemetry/destinations/{id_or_name}","href":"/api-reference/browser-telemetry/get-otlp-destination-by-id-or-name"},{"title":"Delete OTLP destination by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /telemetry/destinations/{id_or_name}","href":"/api-reference/browser-telemetry/delete-otlp-destination-by-id-or-name"},{"title":"Update OTLP destination by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /telemetry/destinations/{id_or_name}","href":"/api-reference/browser-telemetry/update-otlp-destination-by-id-or-name"}]},{"group":"Browser WebMCP","pages":[{"title":"List custom WebMCP tools","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/webmcp/custom-tools","href":"/api-reference/browser-webmcp/list-custom-webmcp-tools"},{"title":"Add custom WebMCP tools","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/webmcp/custom-tools","href":"/api-reference/browser-webmcp/add-custom-webmcp-tools"},{"title":"Remove a custom WebMCP tool","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /browsers/{id_or_name}/webmcp/custom-tools/{id}","href":"/api-reference/browser-webmcp/remove-a-custom-webmcp-tool"},{"title":"Invoke a discovered WebMCP tool","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /browsers/{id_or_name}/webmcp/invoke","href":"/api-reference/browser-webmcp/invoke-a-discovered-webmcp-tool"},{"title":"Discover WebMCP tools across the browser","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /browsers/{id_or_name}/webmcp/tools","href":"/api-reference/browser-webmcp/discover-webmcp-tools-across-the-browser"}]},{"group":"Config Registry","pages":[{"title":"List configs","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /config-registry","href":"/api-reference/config-registry/list-configs"},{"title":"List config analyses","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /config-registry/analyses","href":"/api-reference/config-registry/list-config-analyses"},{"title":"Get a config analysis","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /config-registry/analyses/{id}","href":"/api-reference/config-registry/get-a-config-analysis"},{"title":"Cancel a config analysis","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /config-registry/analyses/{id}/cancel","href":"/api-reference/config-registry/cancel-a-config-analysis"},{"title":"Look up a config","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /config-registry/lookup","href":"/api-reference/config-registry/look-up-a-config"},{"title":"Resolve a config","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /config-registry/resolve","href":"/api-reference/config-registry/resolve-a-config"}]},{"group":"Credentials","pages":[]},{"group":"Deployments","pages":[{"title":"List deployments","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /deployments","href":"/api-reference/deployments/list-deployments"},{"title":"Create a deployment","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /deployments","href":"/api-reference/deployments/create-a-deployment"},{"title":"Get deployment details","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /deployments/{id}","href":"/api-reference/deployments/get-deployment-details"},{"title":"Delete a deployment","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /deployments/{id}","href":"/api-reference/deployments/delete-a-deployment"},{"title":"Stream deployment events via SSE","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /deployments/{id}/events","href":"/api-reference/deployments/stream-deployment-events-via-sse"}]},{"group":"Extensions","pages":[{"title":"List browser extensions","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /extensions","href":"/api-reference/extensions/list-browser-extensions"},{"title":"Upload a browser extension","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /extensions","href":"/api-reference/extensions/upload-a-browser-extension"},{"title":"Download unpacked extension from Chrome Web Store","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /extensions/from_chrome_store","href":"/api-reference/extensions/download-unpacked-extension-from-chrome-web-store"},{"title":"Download extension archive","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /extensions/{id_or_name}","href":"/api-reference/extensions/download-extension-archive"},{"title":"Delete extension by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /extensions/{id_or_name}","href":"/api-reference/extensions/delete-extension-by-id-or-name"},{"title":"Get extension metadata","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /extensions/{id_or_name}/metadata","href":"/api-reference/extensions/get-extension-metadata"}]},{"group":"Invocations","pages":[{"title":"List invocations","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /invocations","href":"/api-reference/invocations/list-invocations"},{"title":"Invoke an action","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /invocations","href":"/api-reference/invocations/invoke-an-action"},{"title":"Get invocation details","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /invocations/{id}","href":"/api-reference/invocations/get-invocation-details"},{"title":"Update invocation","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /invocations/{id}","href":"/api-reference/invocations/update-invocation"},{"title":"List browsers for an invocation","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /invocations/{id}/browsers","href":"/api-reference/invocations/list-browsers-for-an-invocation"},{"title":"Delete browser sessions for an invocation","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /invocations/{id}/browsers","href":"/api-reference/invocations/delete-browser-sessions-for-an-invocation"},{"title":"Stream invocation events via SSE","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /invocations/{id}/events","href":"/api-reference/invocations/stream-invocation-events-via-sse"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /org/api_keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /org/api_keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Get an API key","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /org/api_keys/{id}","href":"/api-reference/api-keys/get-an-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /org/api_keys/{id}","href":"/api-reference/api-keys/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /org/api_keys/{id}","href":"/api-reference/api-keys/update-an-api-key"},{"title":"Rotate an API key","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /org/api_keys/{id}/rotate","href":"/api-reference/api-keys/rotate-an-api-key"}]},{"group":"Credential Providers","pages":[]},{"group":"Organization","pages":[{"title":"Get organization entitlements","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /org/entitlements","href":"/api-reference/organization/get-organization-entitlements"},{"title":"Get organization limits","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /org/limits","href":"/api-reference/organization/get-organization-limits"},{"title":"Update organization limits","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /org/limits","href":"/api-reference/organization/update-organization-limits"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /org/projects","href":"/api-reference/projects/list-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /org/projects","href":"/api-reference/projects/create-a-project"},{"title":"Get a project by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /org/projects/{id_or_name}","href":"/api-reference/projects/get-a-project-by-id-or-name"},{"title":"Delete a project by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /org/projects/{id_or_name}","href":"/api-reference/projects/delete-a-project-by-id-or-name"},{"title":"Update a project by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /org/projects/{id_or_name}","href":"/api-reference/projects/update-a-project-by-id-or-name"},{"title":"Get project limits by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /org/projects/{id_or_name}/limits","href":"/api-reference/projects/get-project-limits-by-id-or-name"},{"title":"Update project limits by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /org/projects/{id_or_name}/limits","href":"/api-reference/projects/update-project-limits-by-id-or-name"},{"title":"List projects","deprecated":true,"version":null,"openapi":"https://api.onkernel.com/spec.json get /projects","href":"/api-reference/projects/list-projects-1"},{"title":"Create a project","deprecated":true,"version":null,"openapi":"https://api.onkernel.com/spec.json post /projects","href":"/api-reference/projects/create-a-project-1"},{"title":"Get a project by ID or name","deprecated":true,"version":null,"openapi":"https://api.onkernel.com/spec.json get /projects/{id_or_name}","href":"/api-reference/projects/get-a-project-by-id-or-name-1"},{"title":"Delete a project by ID or name","deprecated":true,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /projects/{id_or_name}","href":"/api-reference/projects/delete-a-project-by-id-or-name-1"},{"title":"Update a project by ID or name","deprecated":true,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /projects/{id_or_name}","href":"/api-reference/projects/update-a-project-by-id-or-name-1"},{"title":"Get project limits by ID or name","deprecated":true,"version":null,"openapi":"https://api.onkernel.com/spec.json get /projects/{id_or_name}/limits","href":"/api-reference/projects/get-project-limits-by-id-or-name-1"},{"title":"Update project limits by ID or name","deprecated":true,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /projects/{id_or_name}/limits","href":"/api-reference/projects/update-project-limits-by-id-or-name-1"}]},{"group":"Profiles","pages":[{"title":"List profiles","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /profiles","href":"/api-reference/profiles/list-profiles"},{"title":"Create a new profile","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /profiles","href":"/api-reference/profiles/create-a-new-profile"},{"title":"Get profile by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /profiles/{id_or_name}","href":"/api-reference/profiles/get-profile-by-id-or-name"},{"title":"Delete profile by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /profiles/{id_or_name}","href":"/api-reference/profiles/delete-profile-by-id-or-name"},{"title":"Rename profile by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /profiles/{id_or_name}","href":"/api-reference/profiles/rename-profile-by-id-or-name"},{"title":"Download profile archive","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /profiles/{id_or_name}/download","href":"/api-reference/profiles/download-profile-archive"}]},{"group":"Proxies","pages":[{"title":"List proxies","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /proxies","href":"/api-reference/proxies/list-proxies"},{"title":"Create a proxy","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /proxies","href":"/api-reference/proxies/create-a-proxy"},{"title":"Get proxy by ID or name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /proxies/{id_or_name}","href":"/api-reference/proxies/get-proxy-by-id-or-name"},{"title":"Delete proxy by ID","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /proxies/{id_or_name}","href":"/api-reference/proxies/delete-proxy-by-id"},{"title":"Rename proxy by ID","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /proxies/{id_or_name}","href":"/api-reference/proxies/rename-proxy-by-id"},{"title":"Check proxy health","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /proxies/{id_or_name}/check","href":"/api-reference/proxies/check-proxy-health"}]},{"group":"Vaults","pages":[{"title":"List provider configurations in the organization","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /vault-provider-configs","href":"/api-reference/vaults/list-provider-configurations-in-the-organization"},{"title":"Register a provider configuration","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /vault-provider-configs","href":"/api-reference/vaults/register-a-provider-configuration"},{"title":"Get a provider configuration","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /vault-provider-configs/{id_or_name}","href":"/api-reference/vaults/get-a-provider-configuration"},{"title":"Delete an unused provider configuration","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /vault-provider-configs/{id_or_name}","href":"/api-reference/vaults/delete-an-unused-provider-configuration"},{"title":"Update a provider configuration","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /vault-provider-configs/{id_or_name}","href":"/api-reference/vaults/update-a-provider-configuration"},{"title":"List vaults in the current project","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /vaults","href":"/api-reference/vaults/list-vaults-in-the-current-project"},{"title":"Create or retrieve a vault by immutable name","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /vaults","href":"/api-reference/vaults/create-or-retrieve-a-vault-by-immutable-name"},{"title":"Get a vault","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /vaults/{id_or_name}","href":"/api-reference/vaults/get-a-vault"},{"title":"Delete a vault and invalidate its items","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /vaults/{id_or_name}","href":"/api-reference/vaults/delete-a-vault-and-invalidate-its-items"},{"title":"Get a vault's public key for browser-encrypted credential values","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /vaults/{id_or_name}/encryption_key","href":"/api-reference/vaults/get-a-vaults-public-key-for-browser-encrypted-credential-values"},{"title":"List vault items without secret values","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /vaults/{id_or_name}/items","href":"/api-reference/vaults/list-vault-items-without-secret-values"},{"title":"Get a vault item, its currently available operations, and optionally expanded live data","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /vaults/{id_or_name}/items/{key}","href":"/api-reference/vaults/get-a-vault-item-its-currently-available-operations-and-optionally-expanded-live-data"},{"title":"Create or retrieve an identical vault item by immutable key","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json put /vaults/{id_or_name}/items/{key}","href":"/api-reference/vaults/create-or-retrieve-an-identical-vault-item-by-immutable-key"},{"title":"Delete a vault item and invalidate its secret value","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json delete /vaults/{id_or_name}/items/{key}","href":"/api-reference/vaults/delete-a-vault-item-and-invalidate-its-secret-value"},{"title":"Update a card specification or credential values","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json patch /vaults/{id_or_name}/items/{key}","href":"/api-reference/vaults/update-a-card-specification-or-credential-values"},{"title":"List immutable audit events for a vault item","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json get /vaults/{id_or_name}/items/{key}/events","href":"/api-reference/vaults/list-immutable-audit-events-for-a-vault-item"},{"title":"Perform an operation advertised by a vault item","deprecated":null,"version":null,"openapi":"https://api.onkernel.com/spec.json post /vaults/{id_or_name}/items/{key}/operations","href":"/api-reference/vaults/perform-an-operation-advertised-by-a-vault-item"}]}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/reference/cli"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/reference/mcp-server"}]},{"tab":"Changelog","href":"https://www.kernel.sh/changelog"}]},"basePath":"","title":"Start login flow - Kernel","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_4Sesi0.js","utils-DRHeK26p.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6d-DUc2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dex7slho.js","snippetPresets-BcCEBp0Z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CufowNTX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-A4lJSCIe.js","shallow-DqoHP7zn.js","getApiPlaygroundDisplay-Cku8AmtL.js","CodeSnippet-CtHQbNqc.js","CodeSnippets-CGo5Cslf.js","Page-BoJxk0m8.js","getPastedJson-M-bKdue4.js","icon-DEqCU4st.js","MethodPill-DnfSSXiJ.js","DuplicateIcon-BHu2PE8M.js","createIcon-BPsE5X7c.js","DynamicMarkdown-Dnt6YhtR.js","SectionHeading-6CtFWqMQ.js","axios-vUo_bRtp.js","Markdown-BoKe_1fI.js","clsx-DM5-sUNJ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CkIdkovK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B3e6Nh_r.js"]}