Returns health status and system information including upgrade count and binary details
Also includes last upgrade attempt status with detailed error information if available
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Documentation","description":"Blaxel documentation: cloud sandboxes, AI agent hosting, MCP servers, batch jobs, and model gateway for building and deploying AI-powered applications.","colors":{"primary":"#F0652D","light":"#FD7B35","dark":"#F0652D"},"logo":{"light":"https://mintcdn.com/blaxel/Z-RIT2VoXMT2Aw7L/images/logo-light.svg?fit=max\u0026auto=format\u0026n=Z-RIT2VoXMT2Aw7L\u0026q=85\u0026s=7a7cf1e3c766c77f97f32e5c0d4fd209","dark":"https://mintcdn.com/blaxel/Z-RIT2VoXMT2Aw7L/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=Z-RIT2VoXMT2Aw7L\u0026q=85\u0026s=17297eca3e92fe15a91eed262f17d659"},"favicon":"https://mintcdn.com/blaxel/nH6Nd4qmP2OsLhOO/favicon.svg?fit=max\u0026auto=format\u0026n=nH6Nd4qmP2OsLhOO\u0026q=85\u0026s=484b8f0ebe3fb56aef259d514eeaa18c","appearance":{"default":"system"},"background":{"color":{"dark":"#09090B"}},"navbar":{"links":[{"icon":"calendar","href":"/changelog","label":"Changelog"},{"icon":"robot","href":"/skills-mcp","label":"Agent Skill"},{"icon":"puzzle-piece","href":"https://blaxel.ai/integrations","label":"Integrations"},{"icon":"discord","href":"/Community","label":"Community"}],"primary":{"type":"button","label":"Blaxel Console","href":"https://app.blaxel.ai"}},"footer":{"socials":{"github":"https://github.com/blaxel-ai","linkedin":"https://www.linkedin.com/company/blaxel-ai","twitter":"https://x.com/blaxelai","discord":"https://discord.gg/CsWKUZUHFQ"}},"search":{"prompt":"Search Blaxel docs..."},"seo":{"metatags":{"og:type":"website","og:site_name":"Blaxel Documentation"},"indexing":"navigable"},"fonts":{"family":"Inter"},"integrations":{"posthog":{"apiKey":"phc_HGJ7t7Qa8cJJilL0CONU5se4vM6jU6nKFCuoCC9LSha","apiHost":"https://events.blaxel.ai"}},"banner":{"content":"Blaxel has joined Baseten to build the future of agentic infrastructure! [Read our announcement.](https://www.baseten.co/blog/blaxel-is-joining-baseten-to-build-the-future-of-agentic-cloud/)","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","cursor","devin","download-spec"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"calendar","href":"/changelog"},{"anchor":"Blaxel Skills \u0026 MCP","icon":"robot","href":"/skills-mcp"},{"anchor":"Integrations directory","icon":"puzzle-piece","href":"https://blaxel.ai/integrations"},{"anchor":"Community","icon":"discord","href":"/Community"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"blaxel","hasAudioNarration":false,"actualSubdomain":"blaxel","customDomains":["docs.blaxel.ai"],"gitSource":{"type":"github","owner":"blaxel-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3fd9d39d5c86a21f7dc2b","collectionId":"857fa55e-77d4-4e24-b81e-4190e709f519","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3fd9d39d5c86a21f7dc2b"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3fd9d39d5c86a21f7dc2b","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Platform APIs Reference","count":179},{"language":"default","tag":"Management API","count":176},{"language":"default","tag":"Documentation","count":114},{"language":"default","tag":"Overview","count":75},{"language":"default","tag":"CLI Reference","count":73},{"language":"default","tag":"Commands","count":72},{"language":"default","tag":"Sandbox API Reference","count":42},{"language":"default","tag":"Troubleshooting","count":41},{"language":"default","tag":"Tutorials and Examples","count":35},{"language":"default","tag":"compute","count":35}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@blaxel.ai","showHelpButton":true}},"basePath":"","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},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar .nav-logo{height:2.5rem;width:auto}#navbar:has(#banner){display:flex;flex-direction:column}#navbar:has(#banner)>.max-w-8xl{width:100%}#navbar:has(#banner)>div[aria-hidden=true]{display:none}#banner{position:relative;inset:auto;order:1;padding:1.25rem 3rem;background:0 0;font-size:.9375rem;font-weight:400}#banner>div{width:100%;max-width:70rem;margin:0;padding:1rem 3.5rem 1rem 1.75rem;border:1px solid #394655;border-radius:.75rem;background:radial-gradient(ellipse at 50% 0,rgb(99 216 226/12%),transparent 70%),linear-gradient(110deg,#121b29,#081827 52%,#141925);box-shadow:0 12px 32px -16px rgb(7 11 17/40%),inset 0 1px 0 rgb(255 255 255/5%)}#banner>button{right:max(4rem,calc((100% - 70rem)/2 + 1rem))}#banner p{color:#dbdbdb!important;line-height:1.5}#banner a{display:inline-flex;align-items:center;gap:.5rem;margin-left:.75rem;color:#fff!important;text-decoration:none;white-space:nowrap}#banner a::after{content:\"\";width:1.25rem;height:1.25rem;background-color:#eb7229;mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 18 18' fill='none' stroke='black' stroke-width='1.25' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M3 9h12M10 4l5 5-5 5'/%3E%3C/svg%3E\") center/contain no-repeat}#banner a:hover{text-decoration:underline;text-decoration-color:#fff}#banner a:focus-visible{border-radius:2px;outline:2px solid #eb7229;outline-offset:4px}@media (max-width:767px){#banner{padding:1rem;text-align:left}#banner>div{padding:1rem 2.75rem 1rem 1rem}#banner a{display:flex;width:fit-content;margin:.375rem 0 0}#banner>button{top:1.75rem;right:1.75rem;transform:none}}"}],"page":{"pagePath":"api-reference/system/health-check","slug":"/api-reference/system/health-check","pageMetadata":{"title":"Health check","description":"Returns health status and system information including upgrade count and binary details\nAlso includes last upgrade attempt status with detailed error information if available","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /health","href":"/api-reference/system/health-check","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: \"Returns health status and system information including upgrade count and binary details\\nAlso includes last upgrade attempt status with detailed error information if available\"\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":"Health check","description":"Returns health status and system information including upgrade count and binary details\nAlso includes last upgrade attempt status with detailed error information if available","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /health","href":"/api-reference/system/health-check","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Returns health status and system information including upgrade count and binary details\nAlso includes last upgrade attempt status with detailed error information if available","responses":{"200":"de3778c1-30ef-4612-a7e2-314da0ddc15a"},"summary":"Health check","tags":["system"],"method":"get","type":"path","servers":["b309c2fa-e4f7-4712-a10f-1e3ddec79583"],"security":["618d9c94-0539-4b13-a173-6b6a046809dc"],"path":"/health","baseUrlOptions":["https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run"],"title":"Health check","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"de3778c1-30ef-4612-a7e2-314da0ddc15a":{"description":"Health status","content":{"application/json":{"schema":{"properties":{"arch":{"example":"amd64","type":"string","isRequired":true,"uniqueKey":"arch","typeLabel":"string"},"buildTime":{"description":"Build time in RFC 3339 (UTC), or \"unknown\" for builds without it","example":"2026-01-29T17:36:52.000Z","type":"string","isRequired":true,"uniqueKey":"buildTime","typeLabel":"string"},"gitCommit":{"example":"abc123","type":"string","isRequired":true,"uniqueKey":"gitCommit","typeLabel":"string"},"goVersion":{"example":"go1.25.0","type":"string","isRequired":true,"uniqueKey":"goVersion","typeLabel":"string"},"lastUpgrade":{"properties":{"status":{"type":"string","description":"Current state (idle, running, completed, failed)","enum":["idle","running","completed","failed"],"x-enum-comments":{"UpgradeStateCompleted":"Upgrade completed successfully","UpgradeStateFailed":"Upgrade failed","UpgradeStateIdle":"No upgrade in progress","UpgradeStateRunning":"Upgrade is currently running"},"x-enum-descriptions":["No upgrade in progress","Upgrade is currently running","Upgrade completed successfully","Upgrade failed"],"x-enum-varnames":["UpgradeStateIdle","UpgradeStateRunning","UpgradeStateCompleted","UpgradeStateFailed"],"example":"running","isRequired":true,"uniqueKey":"lastUpgrade.status","typeLabel":"enum\u003cstring>"},"step":{"description":"Current/last step (none, starting, download, validate, replace, completed, skipped)","example":"download","type":"string","isRequired":true,"uniqueKey":"lastUpgrade.step","typeLabel":"string"},"version":{"description":"Version being upgraded to","example":"latest","type":"string","isRequired":true,"uniqueKey":"lastUpgrade.version","typeLabel":"string"},"binaryPath":{"description":"Path to downloaded binary","example":"/tmp/sandbox-api-new","type":"string","uniqueKey":"lastUpgrade.binaryPath","typeLabel":"string"},"bytesDownloaded":{"description":"Bytes downloaded","example":25034936,"type":"integer","uniqueKey":"lastUpgrade.bytesDownloaded","typeLabel":"integer"},"downloadUrl":{"description":"URL used for download","example":"https://github.com/...","type":"string","uniqueKey":"lastUpgrade.downloadUrl","typeLabel":"string"},"error":{"description":"Error message if failed","example":"Failed to download binary","type":"string","uniqueKey":"lastUpgrade.error","typeLabel":"string"},"lastAttempt":{"description":"When the upgrade was attempted","type":"string","uniqueKey":"lastUpgrade.lastAttempt","typeLabel":"string"}},"required":["status","step","version"],"type":"object","isRequired":true,"uniqueKey":"lastUpgrade","typeLabel":"object"},"os":{"example":"linux","type":"string","isRequired":true,"uniqueKey":"os","typeLabel":"string"},"startedAt":{"description":"API start time in RFC 3339","example":"2026-01-29T18:45:49.000Z","type":"string","isRequired":true,"uniqueKey":"startedAt","typeLabel":"string"},"status":{"example":"ok","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"upgradeCount":{"example":0,"type":"integer","isRequired":true,"uniqueKey":"upgradeCount","typeLabel":"integer"},"uptime":{"example":"1h30m","type":"string","isRequired":true,"uniqueKey":"uptime","typeLabel":"string"},"uptimeSeconds":{"example":5400.5,"type":"number","isRequired":true,"uniqueKey":"uptimeSeconds","typeLabel":"number"},"version":{"example":"v0.1.0","type":"string","isRequired":true,"uniqueKey":"version","typeLabel":"string"}},"required":["arch","buildTime","gitCommit","goVersion","lastUpgrade","os","startedAt","status","upgradeCount","uptime","uptimeSeconds","version"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"arch":"amd64","buildTime":"2026-01-29T17:36:52.000Z","gitCommit":"abc123","goVersion":"go1.25.0","lastUpgrade":{"status":"running","step":"download","version":"latest","binaryPath":"/tmp/sandbox-api-new","bytesDownloaded":25034936,"downloadUrl":"https://github.com/...","error":"Failed to download binary","lastAttempt":"\u003cstring>"},"os":"linux","startedAt":"2026-01-29T18:45:49.000Z","status":"ok","upgradeCount":0,"uptime":"1h30m","uptimeSeconds":5400.5,"version":"v0.1.0"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"618d9c94-0539-4b13-a173-6b6a046809dc":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"b309c2fa-e4f7-4712-a10f-1e3ddec79583":{"url":"https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run","variables":{"sandbox_id":{"default":"unknown"},"workspace_id":{"default":"unknown"},"region":{"default":"unknown"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","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://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml"},"subdomain":"blaxel","siteName":"Documentation","title":"Health check - Documentation","contextualStarterQuestions":[{"_id":"69d94bdad26302b05e2a9805","deploymentId":"672e5f6ba9a398341da2aaec","questionText":"How do I view error details?","status":"active","generatedBy":"contextual","path":"api-reference/system/health-check","createdAt":"2026-04-10T19:13:30.234Z","updatedAt":"2026-04-10T19:13:30.234Z","__v":0},{"_id":"69d94bdad26302b05e2a9803","deploymentId":"672e5f6ba9a398341da2aaec","questionText":"How do I check system health?","status":"active","generatedBy":"contextual","path":"api-reference/system/health-check","createdAt":"2026-04-10T19:13:30.234Z","updatedAt":"2026-04-10T19:13:30.234Z","__v":0},{"_id":"69d94bdad26302b05e2a9804","deploymentId":"672e5f6ba9a398341da2aaec","questionText":"What upgrade info is included?","status":"active","generatedBy":"contextual","path":"api-reference/system/health-check","createdAt":"2026-04-10T19:13:30.234Z","updatedAt":"2026-04-10T19:13:30.234Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/system/health-check.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=\"system\"}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=\"Returns health status and system information including upgrade count and binary details Also includes last upgrade attempt status with detailed error information if available\">\u003cmeta data-mint-head name=\"application-name\" content=\"Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_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=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Health check - Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns health status and system information including upgrade count and binary details Also includes last upgrade attempt status with detailed error information if available\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Blaxel Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.blaxel.ai/api-reference/system/health-check\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://blaxel.mintlify.app/_mintlify/api/og/v2?division=system\u0026amp;title=Health+check\u0026amp;description=Returns+health+status+and+system+information+including+upgrade+count+and+binary+details%0AAlso+includes+last+upgrade+attempt+status+with+detailed+error+informatio\u0026amp;theme=2ee6a4a0c0526ef8591d7c25\u0026amp;signature=98e95ac15a87a3c468371d5e043a69217f5cba647a29d2b5e9ac23cc123825a3\">\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=\"Health check - Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns health status and system information including upgrade count and binary details Also includes last upgrade attempt status with detailed error information if available\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://blaxel.mintlify.app/_mintlify/api/og/v2?division=system\u0026amp;title=Health+check\u0026amp;description=Returns+health+status+and+system+information+including+upgrade+count+and+binary+details%0AAlso+includes+last+upgrade+attempt+status+with+detailed+error+informatio\u0026amp;theme=2ee6a4a0c0526ef8591d7c25\u0026amp;signature=98e95ac15a87a3c468371d5e043a69217f5cba647a29d2b5e9ac23cc123825a3\">\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=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F0652D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.blaxel.ai/api-reference/system/health-check\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/system/health-check.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.blaxel.ai/#organization\",\"name\":\"Documentation\",\"url\":\"https://docs.blaxel.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/blaxel/Z-RIT2VoXMT2Aw7L/images/logo-light.svg?fit=max\u0026auto=format\u0026n=Z-RIT2VoXMT2Aw7L\u0026q=85\u0026s=7a7cf1e3c766c77f97f32e5c0d4fd209\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.blaxel.ai#website\",\"name\":\"Documentation\",\"url\":\"https://docs.blaxel.ai\",\"publisher\":{\"@id\":\"https://docs.blaxel.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.blaxel.ai/api-reference/system/health-check#webpage\",\"url\":\"https://docs.blaxel.ai/api-reference/system/health-check\",\"name\":\"Health check\",\"description\":\"Returns health status and system information including upgrade count and binary details Also includes last upgrade attempt status with detailed error information if available\",\"isPartOf\":{\"@id\":\"https://docs.blaxel.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.blaxel.ai/api-reference/system/health-check#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.blaxel.ai/api-reference/system/health-check#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"system\",\"item\":\"https://docs.blaxel.ai/api-reference/system/reload-environment-from-guest-metadata\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Health check\",\"item\":\"https://docs.blaxel.ai/api-reference/system/health-check\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.blaxel.ai/api-reference/system/health-check#apireference\",\"headline\":\"Health check\",\"name\":\"Health check\",\"description\":\"Returns health status and system information including upgrade count and binary details Also includes last upgrade attempt status with detailed error information if available\",\"url\":\"https://docs.blaxel.ai/api-reference/system/health-check\",\"mainEntityOfPage\":{\"@id\":\"https://docs.blaxel.ai/api-reference/system/health-check#webpage\"},\"publisher\":{\"@id\":\"https://docs.blaxel.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.blaxel.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"calendar","href":"/changelog"},{"anchor":"Blaxel Skills \u0026 MCP","icon":"robot","href":"/skills-mcp"},{"anchor":"Integrations directory","icon":"puzzle-piece","href":"https://blaxel.ai/integrations"},{"anchor":"Community","icon":"discord","href":"/Community"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/Overview"}]},{"tab":"Tutorials and Examples","pages":[{"title":"Tutorials and Examples","href":"/Tutorials/Overview"}]},{"tab":"Platform APIs Reference","pages":[{"title":"Platform APIs Reference","href":"/api-reference/introduction"}]},{"tab":"Sandbox API Reference","groups":[{"group":"archive","pages":[{"title":"Export the filesystem changes to a presigned URL","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /archive/export","href":"/api-reference/archive/export-the-filesystem-changes-to-a-presigned-url"},{"title":"Lift the archive freeze","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /archive/resume","href":"/api-reference/archive/lift-the-archive-freeze"},{"title":"Get the archive status","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /archive/status","href":"/api-reference/archive/get-the-archive-status"}]},{"group":"fastapply","pages":[{"title":"Apply code edit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /codegen/fastapply/{path}","href":"/api-reference/fastapply/apply-code-edit"}]},{"group":"codegen","pages":[{"title":"Code reranking/semantic search","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /codegen/reranking/{path}","href":"/api-reference/codegen/code-rerankingsemantic-search"}]},{"group":"drive","pages":[{"title":"List currently mounted drives","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /drives/mount","href":"/api-reference/drive/list-currently-mounted-drives"},{"title":"Attach a drive to a local path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /drives/mount","href":"/api-reference/drive/attach-a-drive-to-a-local-path"},{"title":"Detach a drive from a local path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /drives/mount/{mountPath}","href":"/api-reference/drive/detach-a-drive-from-a-local-path"}]},{"group":"system","pages":[{"title":"Reload environment from guest metadata","description":"Re-reads /bl/metadata and applies its environment to the sandbox-api process, so this process and every process started afterwards see the current values. Called by the guest init after an environment update; safe to call manually.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /environment/reload","href":"/api-reference/system/reload-environment-from-guest-metadata"},{"title":"Health check","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /health","href":"/api-reference/system/health-check"},{"title":"Upgrade the sandbox-api","description":"Triggers an upgrade of the sandbox-api process. Returns 200 immediately before upgrading.\nThe upgrade will: download the specified binary from GitHub releases, validate it, and restart.\nAll running processes will be preserved across the upgrade.\nAvailable versions: \"latest\" (default, most recent release), \"develop\", \"main\", or specific tag like \"v1.0.0\"\nYou can also specify a custom baseUrl for forks (defaults to https://github.com/blaxel-ai/sandbox/releases)","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /upgrade","href":"/api-reference/system/upgrade-the-sandbox-api"}]},{"group":"filesystem","pages":[{"title":"Search for text content in files","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-content-search/{path}","href":"/api-reference/filesystem/search-for-text-content-in-files"},{"title":"Find files and directories","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-find/{path}","href":"/api-reference/filesystem/find-files-and-directories"},{"title":"List multipart uploads","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-multipart","href":"/api-reference/filesystem/list-multipart-uploads"},{"title":"Abort multipart upload","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /filesystem-multipart/{uploadId}/abort","href":"/api-reference/filesystem/abort-multipart-upload"},{"title":"Complete multipart upload","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /filesystem-multipart/{uploadId}/complete","href":"/api-reference/filesystem/complete-multipart-upload"},{"title":"Upload part","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /filesystem-multipart/{uploadId}/part","href":"/api-reference/filesystem/upload-part"},{"title":"List parts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-multipart/{uploadId}/parts","href":"/api-reference/filesystem/list-parts"},{"title":"Initiate multipart upload","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /filesystem-multipart/initiate/{path}","href":"/api-reference/filesystem/initiate-multipart-upload"},{"title":"Fuzzy search for files and directories","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-search/{path}","href":"/api-reference/filesystem/fuzzy-search-for-files-and-directories"},{"title":"Get file or directory information","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem/{path}","href":"/api-reference/filesystem/get-file-or-directory-information"},{"title":"Create or update a file or directory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /filesystem/{path}","href":"/api-reference/filesystem/create-or-update-a-file-or-directory"},{"title":"Delete file or directory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /filesystem/{path}","href":"/api-reference/filesystem/delete-file-or-directory"},{"title":"Stat a file or directory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml head /filesystem/{path}","href":"/api-reference/filesystem/stat-a-file-or-directory"},{"title":"Get directory tree","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem/tree/{path}","href":"/api-reference/filesystem/get-directory-tree"},{"title":"Create or update directory tree","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /filesystem/tree/{path}","href":"/api-reference/filesystem/create-or-update-directory-tree"},{"title":"Delete directory tree","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /filesystem/tree/{path}","href":"/api-reference/filesystem/delete-directory-tree"},{"title":"Stream file modification events in a directory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /watch/filesystem/{path}","href":"/api-reference/filesystem/stream-file-modification-events-in-a-directory"}]},{"group":"network","pages":[{"title":"Start monitoring ports for a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /network/process/{pid}/monitor","href":"/api-reference/network/start-monitoring-ports-for-a-process"},{"title":"Stop monitoring ports for a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /network/process/{pid}/monitor","href":"/api-reference/network/stop-monitoring-ports-for-a-process"},{"title":"Get open ports for a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /network/process/{pid}/ports","href":"/api-reference/network/get-open-ports-for-a-process"},{"title":"Disconnect tunnel","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /network/tunnel","href":"/api-reference/network/disconnect-tunnel"},{"title":"Update tunnel configuration","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /network/tunnel/config","href":"/api-reference/network/update-tunnel-configuration"}]},{"group":"process","pages":[{"title":"List all processes","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /process","href":"/api-reference/process/list-all-processes"},{"title":"Execute a command","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /process","href":"/api-reference/process/execute-a-command"},{"title":"Get process by identifier","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /process/{identifier}","href":"/api-reference/process/get-process-by-identifier"},{"title":"Stop a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /process/{identifier}","href":"/api-reference/process/stop-a-process"},{"title":"Kill a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /process/{identifier}/kill","href":"/api-reference/process/kill-a-process"},{"title":"Get process logs","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /process/{identifier}/logs","href":"/api-reference/process/get-process-logs"},{"title":"Stream process logs in real time","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /process/{identifier}/logs/stream","href":"/api-reference/process/stream-process-logs-in-real-time"},{"title":"Write to a process's stdin","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /process/{identifier}/stdin","href":"/api-reference/process/write-to-a-processs-stdin"},{"title":"Close a process's stdin","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /process/{identifier}/stdin","href":"/api-reference/process/close-a-processs-stdin"}]}]},{"tab":"SDK Reference","pages":[{"title":"SDK Reference","href":"/sdk-reference/introduction"}]},{"tab":"CLI Reference","pages":[{"title":"CLI Reference","href":"/cli-reference/introduction"}]},{"tab":"Deployment Reference","pages":[{"title":"Deployment Reference","href":"/deployment-reference"}]}]},"basePath":"","title":"Health check - Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-CX_qQQOL.js","dist-BTZUMDnx.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-xpJZXxdP.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","AssistantPageLink-DqdKa2R4.js"]}