node_capacity reports cluster nodes that could host a worker for each GPU
type right now. A ready node is capacity nobody has claimed yet, which is
not the same thing as a worker running on it: with a node up the first
task waits only for a pod to start, without one it waits for a node too.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"levers9","description":"Levers AI Lab: run functions, endpoints, queues, sandboxes, notebooks and GPU jobs on your own cluster; build datasets with human annotation; post-train call agents with human feedback.","colors":{"primary":"#5b9cf6","light":"#8ec0ff","dark":"#2f6fd6"},"logo":{"light":"https://mintcdn.com/levers9/MpDd6UF8JRoz9i--/logo/levers-light.png?fit=max\u0026auto=format\u0026n=MpDd6UF8JRoz9i--\u0026q=85\u0026s=19f74bdb4d66b7ef5afff595f7d598b9","dark":"https://mintcdn.com/levers9/MpDd6UF8JRoz9i--/logo/levers-dark.png?fit=max\u0026auto=format\u0026n=MpDd6UF8JRoz9i--\u0026q=85\u0026s=106049e1271483140250d7d0f8aa184a","href":"https://uselevers.com"},"favicon":"https://mintcdn.com/levers9/MpDd6UF8JRoz9i--/favicon.png?fit=max\u0026auto=format\u0026n=MpDd6UF8JRoz9i--\u0026q=85\u0026s=dde5213235f0c63c31a52d69f714e3d6","navbar":{"links":[{"href":"https://levers9-app.uselevers.com","label":"Dashboard"},{"href":"https://pypi.org/project/levers9/","label":"PyPI"}],"primary":{"type":"github","href":"https://github.com/gnomefin/levers9"}},"footer":{"socials":{"github":"https://github.com/gnomefin/levers9","website":"https://uselevers.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"levers9","hasAudioNarration":false,"actualSubdomain":"levers9","customDomains":[],"gitSource":{"type":"github","owner":"gnomefin","repo":"levers9","deployBranch":"main","contentDirectory":"docs/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ade1e7812d8b1b7b9f0fbc1","collectionId":"6113fcb0-75fa-4a83-b6e8-5990f2d9797e","liveDeploymentHistoryId":"6ade1e7812d8b1b7b9f0fbc1","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ade1e7812d8b1b7b9f0fbc1","clientVersion":"0.0.4005","searchFilterCounts":[{"language":"default","tag":"API reference","count":112},{"language":"default","tag":"ControlPlane","count":67},{"language":"default","tag":"ControlPlaneService","count":67},{"language":"default","tag":"Guides","count":60},{"language":"default","tag":"Boxes","count":24},{"language":"default","tag":"BoxService","count":24},{"language":"default","tag":"Build with the SDK","count":16},{"language":"default","tag":"RL Arena","count":13},{"language":"default","tag":"Volumes","count":13},{"language":"default","tag":"VolumeService","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/controlplaneservice/machines","slug":"/api-reference/controlplaneservice/machines","pageMetadata":{"title":"Machines","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /machines","href":"/api-reference/controlplaneservice/machines","autogeneratedByOpenApi":true},"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":"Machines","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /machines","href":"/api-reference/controlplaneservice/machines","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Machines","operationId":"ControlPlaneService_ListMachines","responses":{"200":"b93e91d2-f349-43ca-ab2c-c69a8a2dbf2b","default":"96488b5b-7765-4753-8674-0a84289738f6"},"parameters":["add76ae7-3952-4fff-8861-7dfb58abcc8a","75468b95-0ce0-4586-8875-39584d6c0af8"],"tags":["ControlPlaneService"],"method":"get","type":"path","servers":["75403181-f1b0-4dd4-aa1a-20f130dfaf52","33060361-d564-43b4-9902-6b48d8f64d3e"],"security":["1fded91b-431c-4ba2-b30d-603b0a0f3bec"],"path":"/machines","baseUrlOptions":["https://levers9.uselevers.com","https://api.uselevers.com"],"title":"Machines","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"add76ae7-3952-4fff-8861-7dfb58abcc8a":{"name":"poolName","in":"query","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"75468b95-0ce0-4586-8875-39584d6c0af8":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int64","isRequired":false,"uniqueKey":"","typeLabel":"integer\u003cint64>"}}},"responses":{"b93e91d2-f349-43ca-ab2c-c69a8a2dbf2b":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","uniqueKey":"ok","typeLabel":"boolean"},"errMsg":{"type":"string","uniqueKey":"errMsg","typeLabel":"string"},"machines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"machines.items.[INDEX].id","typeLabel":"string"},"cpu":{"type":"string","format":"int64","uniqueKey":"machines.items.[INDEX].cpu","typeLabel":"string\u003cint64>"},"memory":{"type":"string","format":"int64","uniqueKey":"machines.items.[INDEX].memory","typeLabel":"string\u003cint64>"},"gpu":{"type":"string","uniqueKey":"machines.items.[INDEX].gpu","typeLabel":"string"},"gpuCount":{"type":"integer","format":"int64","uniqueKey":"machines.items.[INDEX].gpuCount","typeLabel":"integer\u003cint64>"},"status":{"type":"string","uniqueKey":"machines.items.[INDEX].status","typeLabel":"string"},"poolName":{"type":"string","uniqueKey":"machines.items.[INDEX].poolName","typeLabel":"string"},"providerName":{"type":"string","uniqueKey":"machines.items.[INDEX].providerName","typeLabel":"string"},"registrationToken":{"type":"string","uniqueKey":"machines.items.[INDEX].registrationToken","typeLabel":"string"},"tailscaleUrl":{"type":"string","uniqueKey":"machines.items.[INDEX].tailscaleUrl","typeLabel":"string"},"tailscaleAuth":{"type":"string","uniqueKey":"machines.items.[INDEX].tailscaleAuth","typeLabel":"string"},"lastKeepalive":{"type":"string","uniqueKey":"machines.items.[INDEX].lastKeepalive","typeLabel":"string"},"created":{"type":"string","uniqueKey":"machines.items.[INDEX].created","typeLabel":"string"},"machineVersion":{"type":"string","uniqueKey":"machines.items.[INDEX].machineVersion","typeLabel":"string"},"machineMetrics":{"type":"object","properties":{"totalCpuAvailable":{"type":"integer","format":"int32","uniqueKey":"machines.items.[INDEX].machineMetrics.totalCpuAvailable","typeLabel":"integer\u003cint32>"},"totalMemoryAvailable":{"type":"integer","format":"int32","uniqueKey":"machines.items.[INDEX].machineMetrics.totalMemoryAvailable","typeLabel":"integer\u003cint32>"},"cpuUtilizationPct":{"type":"number","format":"float","uniqueKey":"machines.items.[INDEX].machineMetrics.cpuUtilizationPct","typeLabel":"number\u003cfloat>"},"memoryUtilizationPct":{"type":"number","format":"float","uniqueKey":"machines.items.[INDEX].machineMetrics.memoryUtilizationPct","typeLabel":"number\u003cfloat>"},"workerCount":{"type":"integer","format":"int32","uniqueKey":"machines.items.[INDEX].machineMetrics.workerCount","typeLabel":"integer\u003cint32>"},"containerCount":{"type":"integer","format":"int32","uniqueKey":"machines.items.[INDEX].machineMetrics.containerCount","typeLabel":"integer\u003cint32>"},"freeGpuCount":{"type":"integer","format":"int32","uniqueKey":"machines.items.[INDEX].machineMetrics.freeGpuCount","typeLabel":"integer\u003cint32>"},"cacheUsagePct":{"type":"number","format":"float","uniqueKey":"machines.items.[INDEX].machineMetrics.cacheUsagePct","typeLabel":"number\u003cfloat>"},"cacheCapacity":{"type":"integer","format":"int32","uniqueKey":"machines.items.[INDEX].machineMetrics.cacheCapacity","typeLabel":"integer\u003cint32>"},"cacheMemoryUsage":{"type":"integer","format":"int32","uniqueKey":"machines.items.[INDEX].machineMetrics.cacheMemoryUsage","typeLabel":"integer\u003cint32>"},"cacheCpuUsage":{"type":"number","format":"float","uniqueKey":"machines.items.[INDEX].machineMetrics.cacheCpuUsage","typeLabel":"number\u003cfloat>"},"memoryUsedMb":{"type":"string","format":"int64","uniqueKey":"machines.items.[INDEX].machineMetrics.memoryUsedMb","typeLabel":"string\u003cint64>"},"memoryTotalMb":{"type":"string","format":"int64","uniqueKey":"machines.items.[INDEX].machineMetrics.memoryTotalMb","typeLabel":"string\u003cint64>"},"diskUsedMb":{"type":"string","format":"int64","uniqueKey":"machines.items.[INDEX].machineMetrics.diskUsedMb","typeLabel":"string\u003cint64>"},"diskTotalMb":{"type":"string","format":"int64","uniqueKey":"machines.items.[INDEX].machineMetrics.diskTotalMb","typeLabel":"string\u003cint64>"},"diskUsagePct":{"type":"number","format":"float","uniqueKey":"machines.items.[INDEX].machineMetrics.diskUsagePct","typeLabel":"number\u003cfloat>"},"pathMetrics":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","uniqueKey":"machines.items.[INDEX].machineMetrics.pathMetrics.items.[INDEX].label","typeLabel":"string"},"path":{"type":"string","uniqueKey":"machines.items.[INDEX].machineMetrics.pathMetrics.items.[INDEX].path","typeLabel":"string"},"usedMb":{"type":"string","format":"uint64","uniqueKey":"machines.items.[INDEX].machineMetrics.pathMetrics.items.[INDEX].usedMb","typeLabel":"string\u003cuint64>"},"totalMb":{"type":"string","format":"uint64","uniqueKey":"machines.items.[INDEX].machineMetrics.pathMetrics.items.[INDEX].totalMb","typeLabel":"string\u003cuint64>"},"availableMb":{"type":"string","format":"uint64","uniqueKey":"machines.items.[INDEX].machineMetrics.pathMetrics.items.[INDEX].availableMb","typeLabel":"string\u003cuint64>"},"usagePct":{"type":"number","format":"float","uniqueKey":"machines.items.[INDEX].machineMetrics.pathMetrics.items.[INDEX].usagePct","typeLabel":"number\u003cfloat>"}},"uniqueKey":"machines.items.[INDEX].machineMetrics.pathMetrics.items.[INDEX]","typeLabel":"object"},"uniqueKey":"machines.items.[INDEX].machineMetrics.pathMetrics","typeLabel":"object[]"}},"uniqueKey":"machines.items.[INDEX].machineMetrics","typeLabel":"object"},"userData":{"type":"string","uniqueKey":"machines.items.[INDEX].userData","typeLabel":"string"},"ssh":{"type":"object","properties":{"supported":{"type":"boolean","uniqueKey":"machines.items.[INDEX].ssh.supported","typeLabel":"boolean"},"status":{"type":"string","uniqueKey":"machines.items.[INDEX].ssh.status","typeLabel":"string"},"publicIp":{"type":"string","uniqueKey":"machines.items.[INDEX].ssh.publicIp","typeLabel":"string"},"host":{"type":"string","uniqueKey":"machines.items.[INDEX].ssh.host","typeLabel":"string"},"port":{"type":"integer","format":"int64","uniqueKey":"machines.items.[INDEX].ssh.port","typeLabel":"integer\u003cint64>"},"username":{"type":"string","uniqueKey":"machines.items.[INDEX].ssh.username","typeLabel":"string"},"activeGeneration":{"type":"string","format":"uint64","uniqueKey":"machines.items.[INDEX].ssh.activeGeneration","typeLabel":"string\u003cuint64>"},"appliedGeneration":{"type":"string","format":"uint64","uniqueKey":"machines.items.[INDEX].ssh.appliedGeneration","typeLabel":"string\u003cuint64>"},"keyFingerprint":{"type":"string","uniqueKey":"machines.items.[INDEX].ssh.keyFingerprint","typeLabel":"string"},"hostKeyFingerprint":{"type":"string","uniqueKey":"machines.items.[INDEX].ssh.hostKeyFingerprint","typeLabel":"string"},"privateKeyAvailable":{"type":"boolean","uniqueKey":"machines.items.[INDEX].ssh.privateKeyAvailable","typeLabel":"boolean"},"pendingRotation":{"type":"boolean","uniqueKey":"machines.items.[INDEX].ssh.pendingRotation","typeLabel":"boolean"},"pendingGeneration":{"type":"string","format":"uint64","uniqueKey":"machines.items.[INDEX].ssh.pendingGeneration","typeLabel":"string\u003cuint64>"},"pendingFingerprint":{"type":"string","uniqueKey":"machines.items.[INDEX].ssh.pendingFingerprint","typeLabel":"string"},"pendingKeyAvailable":{"type":"boolean","uniqueKey":"machines.items.[INDEX].ssh.pendingKeyAvailable","typeLabel":"boolean"},"pendingKeyDownloaded":{"type":"boolean","uniqueKey":"machines.items.[INDEX].ssh.pendingKeyDownloaded","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"machines.items.[INDEX].ssh.error","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"machines.items.[INDEX].ssh.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"machines.items.[INDEX].ssh","typeLabel":"object"}},"uniqueKey":"machines.items.[INDEX]","typeLabel":"object"},"uniqueKey":"machines","typeLabel":"object[]"},"gpus":{"type":"object","additionalProperties":{"type":"boolean","uniqueKey":"gpus.additionalProperties","typeLabel":"boolean"},"description":"gpus reports live worker availability per GPU type (a worker with that\nGPU is currently registered).","uniqueKey":"gpus","typeLabel":"object"},"supportedGpus":{"type":"object","additionalProperties":{"type":"boolean","uniqueKey":"supportedGpus.additionalProperties","typeLabel":"boolean"},"description":"supported_gpus reports pool-config-based serverless support per GPU\ntype: true when a pool could serve the GPU even if scaled to zero.","uniqueKey":"supportedGpus","typeLabel":"object"},"maxCpuMillicores":{"type":"integer","format":"int64","description":"Resource ceilings enforced when creating a serverless stub. Private\non-demand pools own their machine and do not use these limits.","uniqueKey":"maxCpuMillicores","typeLabel":"integer\u003cint64>"},"maxMemoryMb":{"type":"integer","format":"int64","uniqueKey":"maxMemoryMb","typeLabel":"integer\u003cint64>"},"nodeCapacity":{"type":"object","additionalProperties":{"type":"object","properties":{"nodes":{"type":"integer","format":"int64","description":"Ready nodes matching the pool's node selector.","uniqueKey":"nodeCapacity.additionalProperties.nodes","typeLabel":"integer\u003cint64>"},"gpus":{"type":"integer","format":"int64","description":"GPUs those nodes advertise as allocatable, in total.","uniqueKey":"nodeCapacity.additionalProperties.gpus","typeLabel":"integer\u003cint64>"}},"description":"Nodes in the cluster that a serverless pool could schedule onto.","uniqueKey":"nodeCapacity.additionalProperties","typeLabel":"object"},"description":"node_capacity reports cluster nodes that could host a worker for each GPU\ntype right now. A ready node is capacity nobody has claimed yet, which is\nnot the same thing as a worker running on it: with a node up the first\ntask waits only for a pod to start, without one it waits for a node too.","uniqueKey":"nodeCapacity","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"errMsg":"\u003cstring>","machines":[{"id":"\u003cstring>","cpu":"\u003cstring>","memory":"\u003cstring>","gpu":"\u003cstring>","gpuCount":123,"status":"\u003cstring>","poolName":"\u003cstring>","providerName":"\u003cstring>","registrationToken":"\u003cstring>","tailscaleUrl":"\u003cstring>","tailscaleAuth":"\u003cstring>","lastKeepalive":"\u003cstring>","created":"\u003cstring>","machineVersion":"\u003cstring>","machineMetrics":{"totalCpuAvailable":123,"totalMemoryAvailable":123,"cpuUtilizationPct":123,"memoryUtilizationPct":123,"workerCount":123,"containerCount":123,"freeGpuCount":123,"cacheUsagePct":123,"cacheCapacity":123,"cacheMemoryUsage":123,"cacheCpuUsage":123,"memoryUsedMb":"\u003cstring>","memoryTotalMb":"\u003cstring>","diskUsedMb":"\u003cstring>","diskTotalMb":"\u003cstring>","diskUsagePct":123,"pathMetrics":[{"label":"\u003cstring>","path":"\u003cstring>","usedMb":"\u003cstring>","totalMb":"\u003cstring>","availableMb":"\u003cstring>","usagePct":123}]},"userData":"\u003cstring>","ssh":{"supported":true,"status":"\u003cstring>","publicIp":"\u003cstring>","host":"\u003cstring>","port":123,"username":"\u003cstring>","activeGeneration":"\u003cstring>","appliedGeneration":"\u003cstring>","keyFingerprint":"\u003cstring>","hostKeyFingerprint":"\u003cstring>","privateKeyAvailable":true,"pendingRotation":true,"pendingGeneration":"\u003cstring>","pendingFingerprint":"\u003cstring>","pendingKeyAvailable":true,"pendingKeyDownloaded":true,"error":"\u003cstring>","updatedAt":"2023-11-07T05:31:56Z"}}],"gpus":{},"supportedGpus":{},"maxCpuMillicores":123,"maxMemoryMb":123,"nodeCapacity":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"96488b5b-7765-4753-8674-0a84289738f6":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","format":"int32","uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string","uniqueKey":"details.items.[INDEX].@type","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"details.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>","details":[{"@type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1fded91b-431c-4ba2-b30d-603b0a0f3bec":{"bearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"}}},"servers":{"75403181-f1b0-4dd4-aa1a-20f130dfaf52":{"url":"https://levers9.uselevers.com","description":"local controlplane"},"33060361-d564-43b4-9902-6b48d8f64d3e":{"url":"https://api.uselevers.com","description":"hosted"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"},"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":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi/controlplane.openapi.json"},"subdomain":"levers9","siteName":"levers9","title":"Machines - levers9","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-25T15:21:37.336Z","originalFileLocation":"api-reference/controlplaneservice/machines.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=\"application-name\" content=\"levers9\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/levers9/Tic-ZUhtiXLp1bN4/_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/levers9/Tic-ZUhtiXLp1bN4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/levers9/Tic-ZUhtiXLp1bN4/_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/levers9/Tic-ZUhtiXLp1bN4/_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/levers9/Tic-ZUhtiXLp1bN4/_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/levers9/Tic-ZUhtiXLp1bN4/_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/levers9/Tic-ZUhtiXLp1bN4/_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/levers9/Tic-ZUhtiXLp1bN4/_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/levers9/Tic-ZUhtiXLp1bN4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Machines - levers9\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"levers9\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://levers9.mintlify.app/_mintlify/api/og/v2?division=ControlPlaneService\u0026amp;title=Machines\u0026amp;theme=3f8683039210dbf61eebe455\u0026amp;signature=112dee1002f07a088326011df147ae886874dc24803d297386161ef7eda7742e\">\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=\"Machines - levers9\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://levers9.mintlify.app/_mintlify/api/og/v2?division=ControlPlaneService\u0026amp;title=Machines\u0026amp;theme=3f8683039210dbf61eebe455\u0026amp;signature=112dee1002f07a088326011df147ae886874dc24803d297386161ef7eda7742e\">\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/levers9/Tic-ZUhtiXLp1bN4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"levers9\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5b9cf6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/controlplaneservice/machines.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://levers9.mintlify.app/#organization\",\"name\":\"levers9\",\"url\":\"https://levers9.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/levers9/MpDd6UF8JRoz9i--/logo/levers-light.png?fit=max\u0026auto=format\u0026n=MpDd6UF8JRoz9i--\u0026q=85\u0026s=19f74bdb4d66b7ef5afff595f7d598b9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://levers9.mintlify.app#website\",\"name\":\"levers9\",\"url\":\"https://levers9.mintlify.app\",\"publisher\":{\"@id\":\"https://levers9.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines#webpage\",\"url\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines\",\"name\":\"Machines\",\"dateModified\":\"2026-10-25T15:21:37.336Z\",\"isPartOf\":{\"@id\":\"https://levers9.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"ControlPlane\",\"item\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/auth\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ControlPlaneService\",\"item\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/auth\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Machines\",\"item\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines#apireference\",\"headline\":\"Machines\",\"name\":\"Machines\",\"url\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines\",\"mainEntityOfPage\":{\"@id\":\"https://levers9.mintlify.app/api-reference/controlplaneservice/machines#webpage\"},\"dateModified\":\"2026-10-25T15:21:37.336Z\",\"publisher\":{\"@id\":\"https://levers9.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://levers9.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"levers9\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"levers9","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/overview"},{"title":"Dashboard API","href":"/api-reference/dashboard-api"}]},{"group":"ControlPlane","pages":[{"group":"ControlPlaneService","pages":[{"title":"Auth","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /auth/authorize","href":"/api-reference/controlplaneservice/auth"},{"title":"Sign payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /auth/sign","href":"/api-reference/controlplaneservice/sign-payload"},{"title":"List containers","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /containers","href":"/api-reference/controlplaneservice/list-containers"},{"title":"Stop container","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /containers/{containerId}/stop","href":"/api-reference/controlplaneservice/stop-container"},{"title":"Deployments","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /deployments","href":"/api-reference/controlplaneservice/deployments"},{"title":"Delete deployment","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json delete /deployments/{id}","href":"/api-reference/controlplaneservice/delete-deployment"},{"title":"Scale deployment","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /deployments/{id}/scale","href":"/api-reference/controlplaneservice/scale-deployment"},{"title":"Start deployment","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /deployments/{id}/start","href":"/api-reference/controlplaneservice/start-deployment"},{"title":"Stop deployment","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /deployments/{id}/stop","href":"/api-reference/controlplaneservice/stop-deployment"},{"title":"Machines","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /machines","href":"/api-reference/controlplaneservice/machines"},{"title":"Create machine","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /machines","href":"/api-reference/controlplaneservice/create-machine"},{"title":"Update machine availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /machines/availability","href":"/api-reference/controlplaneservice/update-machine-availability"},{"title":"Join machine","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /machines/join","href":"/api-reference/controlplaneservice/join-machine"},{"title":"Update machine route status","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /machines/routes/status","href":"/api-reference/controlplaneservice/update-machine-route-status"},{"title":"List machine routes","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /machines/routes:list","href":"/api-reference/controlplaneservice/list-machine-routes"},{"title":"Update machine SSH status","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /machines/ssh/status","href":"/api-reference/controlplaneservice/update-machine-ssh-status"},{"title":"Request machine transport credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /machines/transport-credential","href":"/api-reference/controlplaneservice/request-machine-transport-credential"},{"title":"Delete machine","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json delete /machines/{machineId}","href":"/api-reference/controlplaneservice/delete-machine"},{"title":"List marketplace listings","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /marketplace/listings","href":"/api-reference/controlplaneservice/list-marketplace-listings"},{"title":"Create marketplace listing","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /marketplace/listings","href":"/api-reference/controlplaneservice/create-marketplace-listing"},{"title":"Update marketplace listing","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /marketplace/listings/{listingId}","href":"/api-reference/controlplaneservice/update-marketplace-listing"},{"title":"Delete marketplace listing","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json delete /marketplace/listings/{listingId}","href":"/api-reference/controlplaneservice/delete-marketplace-listing"},{"title":"Get marketplace join command","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /marketplace/listings/{listingId}/join-command","href":"/api-reference/controlplaneservice/get-marketplace-join-command"},{"title":"List marketplace machines","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /marketplace/listings/{listingId}/machines","href":"/api-reference/controlplaneservice/list-marketplace-machines"},{"title":"List marketplace offers","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /marketplace/offers","href":"/api-reference/controlplaneservice/list-marketplace-offers"},{"title":"Get marketplace offer","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /marketplace/offers/{listingId}","href":"/api-reference/controlplaneservice/get-marketplace-offer"},{"title":"List marketplace rentals","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /marketplace/rentals","href":"/api-reference/controlplaneservice/list-marketplace-rentals"},{"title":"Create marketplace rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /marketplace/rentals","href":"/api-reference/controlplaneservice/create-marketplace-rental"},{"title":"Delete marketplace rental","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json delete /marketplace/rentals/{rentalId}","href":"/api-reference/controlplaneservice/delete-marketplace-rental"},{"title":"Launch rental workload","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /marketplace/rentals/{rentalId}/launch","href":"/api-reference/controlplaneservice/launch-rental-workload"},{"title":"Create object","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /objects","href":"/api-reference/controlplaneservice/create-object"},{"title":"Objects","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /objects/{hash}","href":"/api-reference/controlplaneservice/objects"},{"title":"Pools","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /pools","href":"/api-reference/controlplaneservice/pools"},{"title":"Create pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools","href":"/api-reference/controlplaneservice/create-pool"},{"title":"Create byoc pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/byoc","href":"/api-reference/controlplaneservice/create-byoc-pool"},{"title":"Revoke pool join token","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/join-tokens/revoke","href":"/api-reference/controlplaneservice/revoke-pool-join-token"},{"title":"List private pools","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /pools/private","href":"/api-reference/controlplaneservice/list-private-pools"},{"title":"Delete pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json delete /pools/{name}","href":"/api-reference/controlplaneservice/delete-pool"},{"title":"Extend pool capacity","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/{name}/extend","href":"/api-reference/controlplaneservice/extend-pool-capacity"},{"title":"Get byoc pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /pools/{poolName}/byoc","href":"/api-reference/controlplaneservice/get-byoc-pool"},{"title":"Scale byoc pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/{poolName}/byoc/scale","href":"/api-reference/controlplaneservice/scale-byoc-pool"},{"title":"Get pool join command","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/{poolName}/join-command","href":"/api-reference/controlplaneservice/get-pool-join-command"},{"title":"Create pool join token","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/{poolName}/join-tokens","href":"/api-reference/controlplaneservice/create-pool-join-token"},{"title":"List pool machines","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /pools/{poolName}/machines","href":"/api-reference/controlplaneservice/list-pool-machines"},{"title":"List machine containers","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /pools/{poolName}/machines/{machineId}/containers","href":"/api-reference/controlplaneservice/list-machine-containers"},{"title":"Activate machine SSH key","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/{poolName}/machines/{machineId}/ssh/key:activate","href":"/api-reference/controlplaneservice/activate-machine-ssh-key"},{"title":"Download machine SSH key","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/{poolName}/machines/{machineId}/ssh/key:download","href":"/api-reference/controlplaneservice/download-machine-ssh-key"},{"title":"Rotate machine SSH key","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools/{poolName}/machines/{machineId}/ssh/key:rotate","href":"/api-reference/controlplaneservice/rotate-machine-ssh-key"},{"title":"Launch pool capacity","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools:launch","href":"/api-reference/controlplaneservice/launch-pool-capacity"},{"title":"Private compute pools","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /pools:offers","href":"/api-reference/controlplaneservice/private-compute-pools"},{"title":"Stubs","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /stubs","href":"/api-reference/controlplaneservice/stubs"},{"title":"Deploy stub","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /stubs/deploy","href":"/api-reference/controlplaneservice/deploy-stub"},{"title":"Get URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /stubs/{stubId}/url","href":"/api-reference/controlplaneservice/get-url"},{"title":"List tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /tasks","href":"/api-reference/controlplaneservice/list-tasks"},{"title":"End task","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /tasks/end","href":"/api-reference/controlplaneservice/end-task"},{"title":"Tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /tasks/start","href":"/api-reference/controlplaneservice/tasks"},{"title":"Stop tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /tasks/stop","href":"/api-reference/controlplaneservice/stop-tasks"},{"title":"Tokens","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /tokens","href":"/api-reference/controlplaneservice/tokens"},{"title":"Create token","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /tokens","href":"/api-reference/controlplaneservice/create-token"},{"title":"Delete token","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json delete /tokens/{tokenId}","href":"/api-reference/controlplaneservice/delete-token"},{"title":"Toggle token","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /tokens/{tokenId}/toggle","href":"/api-reference/controlplaneservice/toggle-token"},{"title":"Workers","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /workers","href":"/api-reference/controlplaneservice/workers"},{"title":"Cordon worker","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /workers/{workerId}/cordon","href":"/api-reference/controlplaneservice/cordon-worker"},{"title":"Drain worker","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /workers/{workerId}/drain","href":"/api-reference/controlplaneservice/drain-worker"},{"title":"Uncordon worker","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /workers/{workerId}/uncordon","href":"/api-reference/controlplaneservice/uncordon-worker"},{"title":"Workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json get /workspace/config","href":"/api-reference/controlplaneservice/workspace"},{"title":"Create a new workspace with a primary token (cluster admin only). Used by the dashboard\nto provision a workspace for a team or user that signed in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi/controlplane.openapi.json post /workspaces","href":"/api-reference/controlplaneservice/create-a-new-workspace-with-a-primary-token-cluster-admin-only-used-by-the-dashboardto-provision-a-workspace-for-a-team-or-user-that-signed-in"}]}]},{"group":"Boxes","pages":[{"group":"BoxService","pages":[{"title":"Create a box","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes","href":"/api-reference/boxservice/create-a-box"},{"title":"Connect to a box","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/connect","href":"/api-reference/boxservice/connect-to-a-box"},{"title":"Snapshot a box's filesystem as a blueprint","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/create-image-from-filesystem","href":"/api-reference/boxservice/snapshot-a-boxs-filesystem-as-a-blueprint"},{"title":"Create a directory","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/directories","href":"/api-reference/boxservice/create-a-directory"},{"title":"Delete a directory","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json delete /boxes/{containerId}/directories/{containerPath}","href":"/api-reference/boxservice/delete-a-directory"},{"title":"Run a command","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/exec","href":"/api-reference/boxservice/run-a-command"},{"title":"List files","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json get /boxes/{containerId}/files","href":"/api-reference/boxservice/list-files"},{"title":"Download a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json get /boxes/{containerId}/files/download/{containerPath}","href":"/api-reference/boxservice/download-a-file"},{"title":"Find in files","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/files/find","href":"/api-reference/boxservice/find-in-files"},{"title":"Replace in files","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/files/replace","href":"/api-reference/boxservice/replace-in-files"},{"title":"Stat a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json get /boxes/{containerId}/files/stat","href":"/api-reference/boxservice/stat-a-file"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/files/upload","href":"/api-reference/boxservice/upload-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json delete /boxes/{containerId}/files/{containerPath}","href":"/api-reference/boxservice/delete-a-file"},{"title":"Kill a process","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/kill","href":"/api-reference/boxservice/kill-a-process"},{"title":"Update network permissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/network/update","href":"/api-reference/boxservice/update-network-permissions"},{"title":"Expose a port","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/ports/expose","href":"/api-reference/boxservice/expose-a-port"},{"title":"List processes","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json get /boxes/{containerId}/processes","href":"/api-reference/boxservice/list-processes"},{"title":"Snapshot the disks","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/snapshot-disks","href":"/api-reference/boxservice/snapshot-the-disks"},{"title":"Snapshot memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/snapshot-memory","href":"/api-reference/boxservice/snapshot-memory"},{"title":"Get status","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json get /boxes/{containerId}/status","href":"/api-reference/boxservice/get-status"},{"title":"Read stderr","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json get /boxes/{containerId}/stderr","href":"/api-reference/boxservice/read-stderr"},{"title":"Read stdout","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json get /boxes/{containerId}/stdout","href":"/api-reference/boxservice/read-stdout"},{"title":"Update the TTL","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json post /boxes/{containerId}/ttl","href":"/api-reference/boxservice/update-the-ttl"},{"title":"List exposed URLs","deprecated":null,"version":null,"openapi":"/api-reference/openapi/box.openapi.json get /boxes/{containerId}/urls","href":"/api-reference/boxservice/list-exposed-urls"}]}]},{"group":"Volumes","pages":[{"group":"VolumeService","pages":[{"title":"List volumes","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json get /volumes","href":"/api-reference/volumeservice/list-volumes"},{"title":"Get or create a volume","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes","href":"/api-reference/volumeservice/get-or-create-a-volume"},{"title":"Copy path stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes/copy-path","href":"/api-reference/volumeservice/copy-path-stream"},{"title":"Multipart Upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json get /volumes/file-service-info","href":"/api-reference/volumeservice/multipart-upload"},{"title":"Create multipart upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes/multipart-upload","href":"/api-reference/volumeservice/create-multipart-upload"},{"title":"Abort multipart upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes/multipart-upload/abort","href":"/api-reference/volumeservice/abort-multipart-upload"},{"title":"Complete multipart upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes/multipart-upload/complete","href":"/api-reference/volumeservice/complete-multipart-upload"},{"title":"Create presigned URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes/presigned-url","href":"/api-reference/volumeservice/create-presigned-url"},{"title":"Delete volume","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes/{name}/delete","href":"/api-reference/volumeservice/delete-volume"},{"title":"Move path","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes/{originalPath}/move","href":"/api-reference/volumeservice/move-path"},{"title":"List path","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json get /volumes/{path}","href":"/api-reference/volumeservice/list-path"},{"title":"Delete path","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json post /volumes/{path}/delete","href":"/api-reference/volumeservice/delete-path"},{"title":"Stat path","deprecated":null,"version":null,"openapi":"/api-reference/openapi/volume.openapi.json get /volumes/{path}/stat","href":"/api-reference/volumeservice/stat-path"}]}]},{"group":"Blueprints","pages":[{"group":"BlueprintService","pages":[{"title":"Build a blueprint","deprecated":null,"version":null,"openapi":"/api-reference/openapi/blueprint.openapi.json post /blueprints/build","href":"/api-reference/blueprintservice/build-a-blueprint"},{"title":"Verify a blueprint build","deprecated":null,"version":null,"openapi":"/api-reference/openapi/blueprint.openapi.json post /blueprints/verify-build","href":"/api-reference/blueprintservice/verify-a-blueprint-build"}]}]},{"group":"Disks","pages":[{"group":"DiskService","pages":[{"title":"List disks","deprecated":null,"version":null,"openapi":"/api-reference/openapi/disk.openapi.json get /disks","href":"/api-reference/diskservice/list-disks"},{"title":"Get or create a disk","deprecated":null,"version":null,"openapi":"/api-reference/openapi/disk.openapi.json post /disks","href":"/api-reference/diskservice/get-or-create-a-disk"},{"title":"List disk snapshots","deprecated":null,"version":null,"openapi":"/api-reference/openapi/disk.openapi.json get /disks/snapshots","href":"/api-reference/diskservice/list-disk-snapshots"},{"title":"Delete disk","deprecated":null,"version":null,"openapi":"/api-reference/openapi/disk.openapi.json post /disks/{name}/delete","href":"/api-reference/diskservice/delete-disk"}]}]}]}]},"title":"Machines - levers9","buildId":"dpl_48qhjNLiu9iJQQSZJz9Fa2ihBbPH","deploymentId":"dpl_48qhjNLiu9iJQQSZJz9Fa2ihBbPH","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rBlzXElK.js","utils-AjnlCZis.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-swvqTHUt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CG9fqVU0.js","snippetPresets-CQaUsst6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DAdT3l54.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B1x8JMQI.js","shallow-D3oUTT8_.js","getApiPlaygroundDisplay-CXVJ98Sz.js","CodeSnippet-HbTSvyGs.js","CodeSnippets-DvgXFP0T.js","Page-C2raW8UD.js","getPastedJson-CfDE0eLj.js","icon-DBPqa2DN.js","MethodPill-86CHHFOO.js","DuplicateIcon-B5BXvyBd.js","createIcon-C_r05QJX.js","DynamicMarkdown-Cp6hhEk1.js","SectionHeading-RZjzOLoo.js","axios-vUo_bRtp.js","Markdown-B0YOyiNO.js","clsx-Q3eNRTcf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-tb1XVL5i.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9O1lyZBL.js"]}