A point-in-time snapshot of a sandbox. It is a workspace-level object: it outlives the sandbox it was captured from, and can be restored onto a sandbox or forked into a new sandbox or application on its own.
The configuration a snapshot carries, so a sandbox or an application can be created from it once its source object is gone.
Show child attributes
Was this page helpful?
{"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":"6ad95282b2459ee84b28fa64","collectionId":"1a8e782a-c6bd-43af-9b1d-f3b8aa990a7a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad95282b2459ee84b28fa64"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad95282b2459ee84b28fa64","clientVersion":"0.0.3971","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":"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":"workos-sso-scim","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-enabled","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}],"isAtlas":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/compute/get-snapshot","slug":"/api-reference/compute/get-snapshot","pageMetadata":{"title":"Get snapshot","description":"Returns a snapshot of the workspace by ID.","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /snapshots/{snapshotName}","href":"/api-reference/compute/get-snapshot","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 a snapshot of the workspace by ID.\"\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":"Get snapshot","description":"Returns a snapshot of the workspace by ID.","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /snapshots/{snapshotName}","href":"/api-reference/compute/get-snapshot","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Returns a snapshot of the workspace by ID.","operationId":"GetSnapshot","parameters":["40bab9fc-317e-47e4-a78f-1f229ad47337"],"responses":{"200":"fe9bcec9-d343-45b9-b37d-939be981bf5c","404":"f3d6e35f-de0a-43ce-a0b5-679325d1d582"},"security":["4a8f4105-b32e-48ea-bedc-16eedd2d158e","4226b463-d592-4a8e-8366-a6387f0a0b94"],"summary":"Get snapshot","tags":["compute"],"method":"get","type":"path","servers":["a536a08e-8aa3-4846-bdef-05b6e6e35de6","6e43aa8e-4175-40be-be85-b1309c7f1977"],"path":"/snapshots/{snapshotName}","baseUrlOptions":["https://api.blaxel.ai/v0","https://run.blaxel.ai"],"title":"Get snapshot","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"40bab9fc-317e-47e4-a78f-1f229ad47337":{"description":"ID of the snapshot","in":"path","name":"snapshotName","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of the snapshot","uniqueKey":"","typeLabel":"string"}}},"responses":{"fe9bcec9-d343-45b9-b37d-939be981bf5c":{"content":{"application/json":{"schema":{"type":"object","description":"A point-in-time snapshot of a sandbox. It is a workspace-level object: it outlives the sandbox it was captured from, and can be restored onto a sandbox or forked into a new sandbox or application on its own.","properties":{"createdAt":{"type":"string","description":"When the snapshot was created","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"id":{"type":"string","description":"Identifier of the snapshot, unique in the workspace. Workspace-level routes address the snapshot by it.","readOnly":true,"example":"snap_abc123","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"Display name of the snapshot, unique among the snapshots of the sandbox it was captured from. Defaults to the identifier.","example":"my-snapshot","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","description":"Status of the snapshot (pending, ready, failed)","example":"ready","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"workspace":{"type":"string","description":"Workspace owning the snapshot","isRequired":true,"uniqueKey":"workspace","typeLabel":"string"},"createdBy":{"type":"string","description":"Who created the snapshot","uniqueKey":"createdBy","typeLabel":"string"},"sandboxName":{"type":"string","description":"Name of the source sandbox. Kept for compatibility, read source.name instead.","uniqueKey":"sandboxName","typeLabel":"string"},"source":{"type":"object","description":"The object a snapshot was captured from.","properties":{"name":{"type":"string","description":"Name of the object the snapshot was captured from","isRequired":true,"uniqueKey":"source.name","typeLabel":"string"},"deleted":{"type":"boolean","description":"Whether the source object has since been deleted. The snapshot stays usable, the link is only kept for context.","readOnly":true,"uniqueKey":"source.deleted","typeLabel":"boolean"},"kind":{"type":"string","description":"Kind of the object the snapshot was captured from. Defaults to sandbox, the only kind that can be captured today.","enum":["sandbox"],"example":"sandbox","default":"sandbox","uniqueKey":"source.kind","typeLabel":"enum\u003cstring>"}},"required":["name"],"uniqueKey":"source","typeLabel":"object"},"spec":{"type":"object","description":"The configuration a snapshot carries, so a sandbox or an application can be created from it once its source object is gone.","properties":{"generation":{"type":"string","description":"Infrastructure generation the snapshot was captured on. A snapshot only restores on the generation it came from.","enum":["mk2","mk3"],"uniqueKey":"spec.generation","typeLabel":"enum\u003cstring>"},"image":{"type":"string","description":"Image the source object ran","uniqueKey":"spec.image","typeLabel":"string"},"memory":{"type":"integer","description":"Memory in MB the source object ran with","uniqueKey":"spec.memory","typeLabel":"integer"},"ports":{"type":"array","description":"Set of ports for a resource","items":{"type":"object","description":"A port for a resource","properties":{"target":{"type":"integer","description":"The target port of the port","example":8080,"isRequired":true,"uniqueKey":"spec.ports.items.[INDEX].target","typeLabel":"integer"},"name":{"type":"string","description":"The name of the port","example":"http","uniqueKey":"spec.ports.items.[INDEX].name","typeLabel":"string"},"protocol":{"type":"string","description":"The protocol of the port","enum":["HTTP","TCP","UDP","TLS"],"example":"HTTP","uniqueKey":"spec.ports.items.[INDEX].protocol","typeLabel":"enum\u003cstring>"}},"required":["target"],"uniqueKey":"spec.ports.items.[INDEX]","typeLabel":"object"},"uniqueKey":"spec.ports","typeLabel":"object[]"},"region":{"type":"string","description":"Region holding the snapshot. Restores and forks land in it.","uniqueKey":"spec.region","typeLabel":"string"},"volumes":{"type":"array","items":{"type":"object","description":"Configuration for attaching a volume to a sandbox at a specific filesystem path. Defaults to a persistent volume; set type to \"ephemeral\" for disk-backed scratch space created with the sandbox and destroyed when it stops.","properties":{"mountPath":{"type":"string","description":"Absolute filesystem path where the volume will be mounted inside the sandbox","example":"/mnt/data","uniqueKey":"spec.volumes.items.[INDEX].mountPath","typeLabel":"string"},"name":{"type":"string","description":"For persistent volumes, the name of the volume resource to attach (must exist in the same workspace and region). For ephemeral volumes, an identifier used to reference the volume internally.","example":"my-volume","uniqueKey":"spec.volumes.items.[INDEX].name","typeLabel":"string"},"readOnly":{"type":"boolean","description":"If true, the volume is mounted read-only and cannot be modified by the sandbox","example":false,"uniqueKey":"spec.volumes.items.[INDEX].readOnly","typeLabel":"boolean"},"sizeMb":{"type":"integer","description":"Storage capacity in megabytes. Required for ephemeral volumes, ignored for persistent volumes.","example":102400,"uniqueKey":"spec.volumes.items.[INDEX].sizeMb","typeLabel":"integer"},"type":{"type":"string","description":"Type of volume. Defaults to \"persistent\" (an existing volume resource). Use \"ephemeral\" for temporary disk-backed storage created with the sandbox.","enum":["persistent","ephemeral"],"example":"persistent","uniqueKey":"spec.volumes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"spec.volumes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"spec.volumes","typeLabel":"object[]"}},"uniqueKey":"spec","typeLabel":"object"}},"required":["workspace","name","id","createdAt","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"createdAt":"\u003cstring>","id":"snap_abc123","name":"my-snapshot","status":"ready","workspace":"\u003cstring>","createdBy":"\u003cstring>","sandboxName":"\u003cstring>","source":{"name":"\u003cstring>","deleted":true,"kind":"sandbox"},"spec":{"generation":"mk2","image":"\u003cstring>","memory":123,"ports":[{"target":8080,"name":"http","protocol":"HTTP"}],"region":"\u003cstring>","volumes":[{"mountPath":"/mnt/data","name":"my-volume","readOnly":false,"sizeMb":102400,"type":"persistent"}]}}}},"exampleType":"generated"}},"description":"successful operation","exampleType":"generated"},"f3d6e35f-de0a-43ce-a0b5-679325d1d582":{"content":{"application/json":{"schema":{"type":"object","description":"Standard error response returned by the API when a request fails","properties":{"error":{"type":"string","description":"Error type or code identifying the kind of error","example":"Resource already exists","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code of the error","example":409,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Human-readable error message describing what went wrong","example":"Invalid request body","uniqueKey":"message","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Resource already exists","code":409,"message":"Invalid request body"}}},"exampleType":"generated"}},"description":"Not found - Snapshot does not exist","exampleType":"generated"}},"security":{"4a8f4105-b32e-48ea-bedc-16eedd2d158e":{"OAuth2":{"description":"OAuth2 authentication with JWT tokens","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","scopes":{"admin":"Administrative access","agents:create":"Create agents","agents:delete":"Delete agents","agents:get":"Get agent details","agents:list":"List agents","agents:update":"Update agents","apiKey:list":"List API keys","apiKey:write":"Create and delete API keys","applications:create":"Create applications","applications:delete":"Delete applications","applications:get":"Get application details","applications:list":"List applications","applications:update":"Update applications","configurations:list":"List configurations","customdomains:create":"Create custom domains","customdomains:delete":"Delete custom domains","customdomains:get":"Get custom domain details","customdomains:list":"List custom domains","customdomains:update":"Update custom domains","functions:create":"Create functions","functions:delete":"Delete functions","functions:get":"Get function details","functions:list":"List functions","functions:update":"Update functions","integrations:create":"Create integrations","integrations:list":"List integrations","invitations:list":"List invitations","jobs:create":"Create jobs","jobs:delete":"Delete jobs","jobs:get":"Get job details","jobs:list":"List jobs","jobs:update":"Update jobs","locations:list":"List locations","mcphub:list":"List MCP hub resources","models:create":"Create models","models:delete":"Delete models","models:get":"Get model details","models:list":"List models","models:update":"Update models","policies:create":"Create policies","policies:delete":"Delete policies","policies:get":"Get policy details","policies:list":"List policies","policies:update":"Update policies","sandboxes:control":"Control sandbox operations","sandboxes:create":"Create sandboxes","sandboxes:delete":"Delete sandboxes","sandboxes:get":"Get sandbox details","sandboxes:list":"List sandboxes","sandboxes:update":"Update sandboxes","sandboxhub:list":"List sandbox hub resources","secrets:create":"Create secrets","secrets:delete":"Delete secrets","secrets:list":"List secrets","templates:get":"Get template details","templates:list":"List templates","volumeTemplates:create":"Create volume templates","volumeTemplates:delete":"Delete volume templates","volumeTemplates:get":"Get volume template details","volumeTemplates:list":"List volume templates","volumeTemplates:upsert":"Create or update volume templates","volumes:create":"Create volumes","volumes:delete":"Delete volumes","volumes:get":"Get volume details","volumes:list":"List volumes","workspaces:accept":"Accept workspace invitation","workspaces:create":"Create workspaces","workspaces:decline":"Decline workspace invitation","workspaces:delete":"Delete workspaces","workspaces:get":"Get workspace details","workspaces:invite":"Invite users to workspace","workspaces:leave":"Leave workspace","workspaces:list":"List workspaces","workspaces:remove":"Remove users from workspace","workspaces:update":"Update workspaces"},"tokenUrl":"/oauth/token"},"clientCredentials":{"scopes":{"admin":"Administrative access","agents:create":"Create agents","agents:delete":"Delete agents","agents:get":"Get agent details","agents:list":"List agents","agents:update":"Update agents","apiKey:list":"List API keys","apiKey:write":"Create and delete API keys","applications:create":"Create applications","applications:delete":"Delete applications","applications:get":"Get application details","applications:list":"List applications","applications:update":"Update applications","configurations:list":"List configurations","customdomains:create":"Create custom domains","customdomains:delete":"Delete custom domains","customdomains:get":"Get custom domain details","customdomains:list":"List custom domains","customdomains:update":"Update custom domains","functions:create":"Create functions","functions:delete":"Delete functions","functions:get":"Get function details","functions:list":"List functions","functions:update":"Update functions","integrations:create":"Create integrations","integrations:list":"List integrations","invitations:list":"List invitations","jobs:create":"Create jobs","jobs:delete":"Delete jobs","jobs:get":"Get job details","jobs:list":"List jobs","jobs:update":"Update jobs","locations:list":"List locations","mcphub:list":"List MCP hub resources","models:create":"Create models","models:delete":"Delete models","models:get":"Get model details","models:list":"List models","models:update":"Update models","policies:create":"Create policies","policies:delete":"Delete policies","policies:get":"Get policy details","policies:list":"List policies","policies:update":"Update policies","sandboxes:control":"Control sandbox operations","sandboxes:create":"Create sandboxes","sandboxes:delete":"Delete sandboxes","sandboxes:get":"Get sandbox details","sandboxes:list":"List sandboxes","sandboxes:update":"Update sandboxes","sandboxhub:list":"List sandbox hub resources","secrets:create":"Create secrets","secrets:delete":"Delete secrets","secrets:list":"List secrets","templates:get":"Get template details","templates:list":"List templates","volumeTemplates:create":"Create volume templates","volumeTemplates:delete":"Delete volume templates","volumeTemplates:get":"Get volume template details","volumeTemplates:list":"List volume templates","volumeTemplates:upsert":"Create or update volume templates","volumes:create":"Create volumes","volumes:delete":"Delete volumes","volumes:get":"Get volume details","volumes:list":"List volumes","workspaces:accept":"Accept workspace invitation","workspaces:create":"Create workspaces","workspaces:decline":"Decline workspace invitation","workspaces:delete":"Delete workspaces","workspaces:get":"Get workspace details","workspaces:invite":"Invite users to workspace","workspaces:leave":"Leave workspace","workspaces:list":"List workspaces","workspaces:remove":"Remove users from workspace","workspaces:update":"Update workspaces"},"tokenUrl":"/oauth/token"}},"type":"oauth2","scopes":["sandboxes:get"],"schemeName":"OAuth2"}},"4226b463-d592-4a8e-8366-a6387f0a0b94":{"ApiKeyAuth":{"bearerFormat":"API Key","description":"Long-lived API key for programmatic access","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"a536a08e-8aa3-4846-bdef-05b6e6e35de6":{"description":"Blaxel Control Plane","url":"https://api.blaxel.ai/v0"},"6e43aa8e-4175-40be-be85-b1309c7f1977":{"description":"Blaxel Inference","url":"https://run.blaxel.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"OAuth2 authentication with JWT tokens","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","scopes":{"admin":"Administrative access","agents:create":"Create agents","agents:delete":"Delete agents","agents:get":"Get agent details","agents:list":"List agents","agents:update":"Update agents","apiKey:list":"List API keys","apiKey:write":"Create and delete API keys","applications:create":"Create applications","applications:delete":"Delete applications","applications:get":"Get application details","applications:list":"List applications","applications:update":"Update applications","configurations:list":"List configurations","customdomains:create":"Create custom domains","customdomains:delete":"Delete custom domains","customdomains:get":"Get custom domain details","customdomains:list":"List custom domains","customdomains:update":"Update custom domains","functions:create":"Create functions","functions:delete":"Delete functions","functions:get":"Get function details","functions:list":"List functions","functions:update":"Update functions","integrations:create":"Create integrations","integrations:list":"List integrations","invitations:list":"List invitations","jobs:create":"Create jobs","jobs:delete":"Delete jobs","jobs:get":"Get job details","jobs:list":"List jobs","jobs:update":"Update jobs","locations:list":"List locations","mcphub:list":"List MCP hub resources","models:create":"Create models","models:delete":"Delete models","models:get":"Get model details","models:list":"List models","models:update":"Update models","policies:create":"Create policies","policies:delete":"Delete policies","policies:get":"Get policy details","policies:list":"List policies","policies:update":"Update policies","sandboxes:control":"Control sandbox operations","sandboxes:create":"Create sandboxes","sandboxes:delete":"Delete sandboxes","sandboxes:get":"Get sandbox details","sandboxes:list":"List sandboxes","sandboxes:update":"Update sandboxes","sandboxhub:list":"List sandbox hub resources","secrets:create":"Create secrets","secrets:delete":"Delete secrets","secrets:list":"List secrets","templates:get":"Get template details","templates:list":"List templates","volumeTemplates:create":"Create volume templates","volumeTemplates:delete":"Delete volume templates","volumeTemplates:get":"Get volume template details","volumeTemplates:list":"List volume templates","volumeTemplates:upsert":"Create or update volume templates","volumes:create":"Create volumes","volumes:delete":"Delete volumes","volumes:get":"Get volume details","volumes:list":"List volumes","workspaces:accept":"Accept workspace invitation","workspaces:create":"Create workspaces","workspaces:decline":"Decline workspace invitation","workspaces:delete":"Delete workspaces","workspaces:get":"Get workspace details","workspaces:invite":"Invite users to workspace","workspaces:leave":"Leave workspace","workspaces:list":"List workspaces","workspaces:remove":"Remove users from workspace","workspaces:update":"Update workspaces"},"tokenUrl":"/oauth/token"},"clientCredentials":{"scopes":{"admin":"Administrative access","agents:create":"Create agents","agents:delete":"Delete agents","agents:get":"Get agent details","agents:list":"List agents","agents:update":"Update agents","apiKey:list":"List API keys","apiKey:write":"Create and delete API keys","applications:create":"Create applications","applications:delete":"Delete applications","applications:get":"Get application details","applications:list":"List applications","applications:update":"Update applications","configurations:list":"List configurations","customdomains:create":"Create custom domains","customdomains:delete":"Delete custom domains","customdomains:get":"Get custom domain details","customdomains:list":"List custom domains","customdomains:update":"Update custom domains","functions:create":"Create functions","functions:delete":"Delete functions","functions:get":"Get function details","functions:list":"List functions","functions:update":"Update functions","integrations:create":"Create integrations","integrations:list":"List integrations","invitations:list":"List invitations","jobs:create":"Create jobs","jobs:delete":"Delete jobs","jobs:get":"Get job details","jobs:list":"List jobs","jobs:update":"Update jobs","locations:list":"List locations","mcphub:list":"List MCP hub resources","models:create":"Create models","models:delete":"Delete models","models:get":"Get model details","models:list":"List models","models:update":"Update models","policies:create":"Create policies","policies:delete":"Delete policies","policies:get":"Get policy details","policies:list":"List policies","policies:update":"Update policies","sandboxes:control":"Control sandbox operations","sandboxes:create":"Create sandboxes","sandboxes:delete":"Delete sandboxes","sandboxes:get":"Get sandbox details","sandboxes:list":"List sandboxes","sandboxes:update":"Update sandboxes","sandboxhub:list":"List sandbox hub resources","secrets:create":"Create secrets","secrets:delete":"Delete secrets","secrets:list":"List secrets","templates:get":"Get template details","templates:list":"List templates","volumeTemplates:create":"Create volume templates","volumeTemplates:delete":"Delete volume templates","volumeTemplates:get":"Get volume template details","volumeTemplates:list":"List volume templates","volumeTemplates:upsert":"Create or update volume templates","volumes:create":"Create volumes","volumes:delete":"Delete volumes","volumes:get":"Get volume details","volumes:list":"List volumes","workspaces:accept":"Accept workspace invitation","workspaces:create":"Create workspaces","workspaces:decline":"Decline workspace invitation","workspaces:delete":"Delete workspaces","workspaces:get":"Get workspace details","workspaces:invite":"Invite users to workspace","workspaces:leave":"Leave workspace","workspaces:list":"List workspaces","workspaces:remove":"Remove users from workspace","workspaces:update":"Update workspaces"},"tokenUrl":"/oauth/token"}},"type":"oauth2","scopes":["sandboxes:get"],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth2 authentication with JWT tokens","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"},{"schemes":[{"scheme":{"bearerFormat":"API Key","description":"Long-lived API key for programmatic access","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Long-lived API key for programmatic access","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/controlplane.yml"},"subdomain":"blaxel","siteName":"Documentation","title":"Get snapshot - Documentation","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/compute/get-snapshot.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 a snapshot of the workspace by ID.\">\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=\"Get snapshot - Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a snapshot of the workspace by ID.\">\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/compute/get-snapshot\">\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=compute\u0026amp;title=Get+snapshot\u0026amp;description=Returns+a+snapshot+of+the+workspace+by+ID.\u0026amp;theme=2ee6a4a0c0526ef8591d7c25\u0026amp;signature=8756ad07672edce9fbeb8406db362fbbe963f08c9092f2d523c18ff4d27c5f80\">\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=\"Get snapshot - Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a snapshot of the workspace by ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://blaxel.mintlify.app/_mintlify/api/og/v2?division=compute\u0026amp;title=Get+snapshot\u0026amp;description=Returns+a+snapshot+of+the+workspace+by+ID.\u0026amp;theme=2ee6a4a0c0526ef8591d7c25\u0026amp;signature=8756ad07672edce9fbeb8406db362fbbe963f08c9092f2d523c18ff4d27c5f80\">\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/compute/get-snapshot\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/compute/get-snapshot.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/compute/get-snapshot#webpage\",\"url\":\"https://docs.blaxel.ai/api-reference/compute/get-snapshot\",\"name\":\"Get snapshot\",\"description\":\"Returns a snapshot of the workspace by ID.\",\"isPartOf\":{\"@id\":\"https://docs.blaxel.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.blaxel.ai/api-reference/compute/get-snapshot#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.blaxel.ai/api-reference/compute/get-snapshot#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Management API\",\"item\":\"https://docs.blaxel.ai/api-reference/agents/list-all-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"compute\",\"item\":\"https://docs.blaxel.ai/api-reference/compute/list-sandboxes\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get snapshot\",\"item\":\"https://docs.blaxel.ai/api-reference/compute/get-snapshot\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.blaxel.ai/api-reference/compute/get-snapshot#apireference\",\"headline\":\"Get snapshot\",\"name\":\"Get snapshot\",\"description\":\"Returns a snapshot of the workspace by ID.\",\"url\":\"https://docs.blaxel.ai/api-reference/compute/get-snapshot\",\"mainEntityOfPage\":{\"@id\":\"https://docs.blaxel.ai/api-reference/compute/get-snapshot#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","groups":[{"group":"Overview","pages":[{"title":"REST API overview","sidebarTitle":"Overview","href":"/api-reference/introduction"}]},{"group":"Inference API","pages":[{"title":"Inference API","href":"/api-reference/inference"}]},{"group":"Billing API","pages":[{"title":"Billing API endpoint reference","href":"/api-reference/billing"}]},{"group":"Management API","pages":[{"group":"agents","pages":[{"title":"List all agents","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /agents","href":"/api-reference/agents/list-all-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /agents","href":"/api-reference/agents/create-agent"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /agents/{agentName}","href":"/api-reference/agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /agents/{agentName}","href":"/api-reference/agents/update-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /agents/{agentName}","href":"/api-reference/agents/delete-agent"},{"title":"List all agent revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /agents/{agentName}/revisions","href":"/api-reference/agents/list-all-agent-revisions"}]},{"group":"applications","pages":[{"title":"List all applications","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /applications","href":"/api-reference/applications/list-all-applications"},{"title":"Create application","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /applications","href":"/api-reference/applications/create-application"},{"title":"Get application","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /applications/{applicationName}","href":"/api-reference/applications/get-application"},{"title":"Update application","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /applications/{applicationName}","href":"/api-reference/applications/update-application"},{"title":"Delete application","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /applications/{applicationName}","href":"/api-reference/applications/delete-application"},{"title":"List all application revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /applications/{applicationName}/revisions","href":"/api-reference/applications/list-all-application-revisions"}]},{"group":"customdomains","pages":[{"title":"Create application custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /applications/{applicationName}/customdomains","href":"/api-reference/customdomains/create-application-custom-domain"},{"title":"List custom domains","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /customdomains","href":"/api-reference/customdomains/list-custom-domains"},{"title":"Create custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /customdomains","href":"/api-reference/customdomains/create-custom-domain"},{"title":"Get custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /customdomains/{domainName}","href":"/api-reference/customdomains/get-custom-domain"},{"title":"Update custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /customdomains/{domainName}","href":"/api-reference/customdomains/update-custom-domain"},{"title":"Delete custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /customdomains/{domainName}","href":"/api-reference/customdomains/delete-custom-domain"},{"title":"List custom domain shares","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /customdomains/{domainName}/share","href":"/api-reference/customdomains/list-custom-domain-shares"},{"title":"Share a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /customdomains/{domainName}/share","href":"/api-reference/customdomains/share-a-custom-domain"},{"title":"Unshare a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /customdomains/{domainName}/share/{targetWorkspace}","href":"/api-reference/customdomains/unshare-a-custom-domain"},{"title":"Verify custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /customdomains/{domainName}/verify","href":"/api-reference/customdomains/verify-custom-domain"}]},{"group":"changelog","pages":[{"title":"Get latest changelog entries","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /changelog","href":"/api-reference/changelog/get-latest-changelog-entries"}]},{"group":"configurations","pages":[{"title":"Get platform configuration","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /configuration","href":"/api-reference/configurations/get-platform-configuration"}]},{"group":"drives","pages":[{"title":"List drives","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /drives","href":"/api-reference/drives/list-drives"},{"title":"Create a drive","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /drives","href":"/api-reference/drives/create-a-drive"},{"title":"Get a drive","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /drives/{driveName}","href":"/api-reference/drives/get-a-drive"},{"title":"Update a drive","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /drives/{driveName}","href":"/api-reference/drives/update-a-drive"},{"title":"Delete a drive","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /drives/{driveName}","href":"/api-reference/drives/delete-a-drive"},{"title":"Create drive access token","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /drives/{driveName}/access-token","href":"/api-reference/drives/create-drive-access-token"},{"title":"Delete a folder and its contents","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /drives/{driveName}/folders","href":"/api-reference/drives/delete-a-folder-and-its-contents"},{"title":"Get drive by external ID","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /drives/by-external-id/{externalId}","href":"/api-reference/drives/get-drive-by-external-id"},{"title":"Get drive token JWKS","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /drives/jwks.json","href":"/api-reference/drives/get-drive-token-jwks"}]},{"group":"vpcs","pages":[{"title":"List all egress gateways across all VPCs in the workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /egressgateways","href":"/api-reference/vpcs/list-all-egress-gateways-across-all-vpcs-in-the-workspace"},{"title":"Egress gateway sandbox attachments","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /egressgateways/usage","href":"/api-reference/vpcs/egress-gateway-sandbox-attachments"},{"title":"List all egress IPs across all VPCs and gateways in the workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /egressips","href":"/api-reference/vpcs/list-all-egress-ips-across-all-vpcs-and-gateways-in-the-workspace"},{"title":"List all VPCs in the workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs","href":"/api-reference/vpcs/list-all-vpcs-in-the-workspace"},{"title":"Create a VPC for the workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /vpcs","href":"/api-reference/vpcs/create-a-vpc-for-the-workspace"},{"title":"Get a VPC by name","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}","href":"/api-reference/vpcs/get-a-vpc-by-name"},{"title":"Delete a VPC","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /vpcs/{vpcName}","href":"/api-reference/vpcs/delete-a-vpc"},{"title":"List egress gateways in a VPC","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}/egressgateways","href":"/api-reference/vpcs/list-egress-gateways-in-a-vpc"},{"title":"Create an egress gateway in a VPC","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /vpcs/{vpcName}/egressgateways","href":"/api-reference/vpcs/create-an-egress-gateway-in-a-vpc"},{"title":"Get an egress gateway by name","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}/egressgateways/{gatewayName}","href":"/api-reference/vpcs/get-an-egress-gateway-by-name"},{"title":"Delete an egress gateway","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /vpcs/{vpcName}/egressgateways/{gatewayName}","href":"/api-reference/vpcs/delete-an-egress-gateway"},{"title":"List egress IPs in a gateway","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}/egressgateways/{gatewayName}/ips","href":"/api-reference/vpcs/list-egress-ips-in-a-gateway"},{"title":"Allocate a new egress IP from the gateway","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /vpcs/{vpcName}/egressgateways/{gatewayName}/ips","href":"/api-reference/vpcs/allocate-a-new-egress-ip-from-the-gateway"},{"title":"Get an egress IP by name","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}/egressgateways/{gatewayName}/ips/{ipName}","href":"/api-reference/vpcs/get-an-egress-ip-by-name"},{"title":"Delete an egress IP","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /vpcs/{vpcName}/egressgateways/{gatewayName}/ips/{ipName}","href":"/api-reference/vpcs/delete-an-egress-ip"}]},{"group":"workspaces","pages":[{"title":"Get enabled features for workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /features","href":"/api-reference/workspaces/get-enabled-features-for-workspace"},{"title":"List workspace team members","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /users","href":"/api-reference/workspaces/list-workspace-team-members"},{"title":"Invite user to workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /users","href":"/api-reference/workspaces/invite-user-to-workspace"},{"title":"Update user role in workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /users/{subOrEmail}","href":"/api-reference/workspaces/update-user-role-in-workspace"},{"title":"Remove user from workspace or revoke invitation","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /users/{subOrEmail}","href":"/api-reference/workspaces/remove-user-from-workspace-or-revoke-invitation"},{"title":"List accessible workspaces","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /workspaces","href":"/api-reference/workspaces/list-accessible-workspaces"},{"title":"Create workspace tenant","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /workspaces","href":"/api-reference/workspaces/create-workspace-tenant"},{"title":"Get workspace details","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /workspaces/{workspaceName}","href":"/api-reference/workspaces/get-workspace-details"},{"title":"Update workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /workspaces/{workspaceName}","href":"/api-reference/workspaces/update-workspace"},{"title":"Delete workspace tenant","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /workspaces/{workspaceName}","href":"/api-reference/workspaces/delete-workspace-tenant"},{"title":"Leave workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /workspaces/{workspaceName}/leave","href":"/api-reference/workspaces/leave-workspace"},{"title":"Check workspace availability","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /workspaces/availability","href":"/api-reference/workspaces/check-workspace-availability"}]},{"group":"featureFlags","pages":[{"title":"Retrieve feature flag evaluation for workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /features/{featureKey}","href":"/api-reference/featureflags/retrieve-feature-flag-evaluation-for-workspace"}]},{"group":"functions","pages":[{"title":"List all MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /functions","href":"/api-reference/functions/list-all-mcp-servers"},{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /functions","href":"/api-reference/functions/create-mcp-server"},{"title":"Get MCP server","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /functions/{functionName}","href":"/api-reference/functions/get-mcp-server"},{"title":"Update MCP server","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /functions/{functionName}","href":"/api-reference/functions/update-mcp-server"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /functions/{functionName}","href":"/api-reference/functions/delete-mcp-server"},{"title":"List function revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /functions/{functionName}/revisions","href":"/api-reference/functions/list-function-revisions"}]},{"group":"images","pages":[{"title":"List container images","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /images","href":"/api-reference/images/list-container-images"},{"title":"Build a container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /images","href":"/api-reference/images/build-a-container-image"},{"title":"Cleanup unused container images","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /images","href":"/api-reference/images/cleanup-unused-container-images"},{"title":"Get container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /images/{resourceType}/{imageName}","href":"/api-reference/images/get-container-image"},{"title":"Delete container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /images/{resourceType}/{imageName}","href":"/api-reference/images/delete-container-image"},{"title":"List image shares","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /images/{resourceType}/{imageName}/share","href":"/api-reference/images/list-image-shares"},{"title":"Share a container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /images/{resourceType}/{imageName}/share","href":"/api-reference/images/share-a-container-image"},{"title":"Unshare a container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /images/{resourceType}/{imageName}/share/{targetWorkspace}","href":"/api-reference/images/unshare-a-container-image"},{"title":"List image tags","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /images/{resourceType}/{imageName}/tags","href":"/api-reference/images/list-image-tags"},{"title":"Delete container image tag","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /images/{resourceType}/{imageName}/tags/{tagName}","href":"/api-reference/images/delete-container-image-tag"},{"title":"List pending image shares","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /pending-image-shares","href":"/api-reference/images/list-pending-image-shares"},{"title":"Accept a pending image share","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /pending-image-shares/{pendingShareId}/accept","href":"/api-reference/images/accept-a-pending-image-share"},{"title":"Decline a pending image share","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /pending-image-shares/{pendingShareId}/decline","href":"/api-reference/images/decline-a-pending-image-share"}]},{"group":"integrations","pages":[{"title":"Get integration provider info","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/{integrationName}","href":"/api-reference/integrations/get-integration-provider-info"},{"title":"List integration connections","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections","href":"/api-reference/integrations/list-integration-connections"},{"title":"Create integration connection","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /integrations/connections","href":"/api-reference/integrations/create-integration-connection"},{"title":"Get integration connection","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections/{connectionName}","href":"/api-reference/integrations/get-integration-connection"},{"title":"Update integration connection","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /integrations/connections/{connectionName}","href":"/api-reference/integrations/update-integration-connection"},{"title":"Delete integration connection","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /integrations/connections/{connectionName}","href":"/api-reference/integrations/delete-integration-connection"},{"title":"Get integration connection model endpoint configurations","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections/{connectionName}/endpointConfigurations","href":"/api-reference/integrations/get-integration-connection-model-endpoint-configurations"},{"title":"List integration connection models","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections/{connectionName}/models","href":"/api-reference/integrations/list-integration-connection-models"},{"title":"Get integration connection model","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections/{connectionName}/models/{modelId}","href":"/api-reference/integrations/get-integration-connection-model"}]},{"group":"jobs","pages":[{"title":"List batch jobs","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs","href":"/api-reference/jobs/list-batch-jobs"},{"title":"Create batch job","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /jobs","href":"/api-reference/jobs/create-batch-job"},{"title":"Get batch job","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}","href":"/api-reference/jobs/get-batch-job"},{"title":"Update batch job","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /jobs/{jobId}","href":"/api-reference/jobs/update-batch-job"},{"title":"Delete batch job","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /jobs/{jobId}","href":"/api-reference/jobs/delete-batch-job"},{"title":"List job executions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}/executions","href":"/api-reference/jobs/list-job-executions"},{"title":"Create job execution","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /jobs/{jobId}/executions","href":"/api-reference/jobs/create-job-execution"},{"title":"Get job execution","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}/executions/{executionId}","href":"/api-reference/jobs/get-job-execution"},{"title":"Cancel job execution","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /jobs/{jobId}/executions/{executionId}","href":"/api-reference/jobs/cancel-job-execution"},{"title":"List execution tasks","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}/executions/{executionId}/tasks","href":"/api-reference/jobs/list-execution-tasks"},{"title":"List job revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}/revisions","href":"/api-reference/jobs/list-job-revisions"}]},{"group":"locations","pages":[{"title":"List deployment regions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /locations","href":"/api-reference/locations/list-deployment-regions"}]},{"group":"mcphub","pages":[{"title":"List MCP Hub servers","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /mcp/hub","href":"/api-reference/mcphub/list-mcp-hub-servers"}]},{"group":"models","pages":[{"title":"List model endpoints","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /models","href":"/api-reference/models/list-model-endpoints"},{"title":"Create model endpoint","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /models","href":"/api-reference/models/create-model-endpoint"},{"title":"Get model endpoint","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /models/{modelName}","href":"/api-reference/models/get-model-endpoint"},{"title":"Update model endpoint","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /models/{modelName}","href":"/api-reference/models/update-model-endpoint"},{"title":"Delete model endpoint","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /models/{modelName}","href":"/api-reference/models/delete-model-endpoint"},{"title":"List model revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /models/{modelName}/revisions","href":"/api-reference/models/list-model-revisions"}]},{"group":"policies","pages":[{"title":"List governance policies","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /policies","href":"/api-reference/policies/list-governance-policies"},{"title":"Create governance policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /policies","href":"/api-reference/policies/create-governance-policy"},{"title":"Get governance policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /policies/{policyName}","href":"/api-reference/policies/get-governance-policy"},{"title":"Update governance policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /policies/{policyName}","href":"/api-reference/policies/update-governance-policy"},{"title":"Delete governance policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /policies/{policyName}","href":"/api-reference/policies/delete-governance-policy"},{"title":"List resources using a policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /policies/{policyName}/usages","href":"/api-reference/policies/list-resources-using-a-policy"}]},{"group":"publicIps:list","pages":[{"title":"List public ips","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /publicIps","href":"/api-reference/publicips:list/list-public-ips"}]},{"group":"sandboxhub","pages":[{"title":"List Sandbox Hub templates","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandbox/hub","href":"/api-reference/sandboxhub/list-sandbox-hub-templates"}]},{"group":"compute","pages":[{"title":"List sandboxes","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes","href":"/api-reference/compute/list-sandboxes"},{"title":"Create sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes","href":"/api-reference/compute/create-sandbox"},{"title":"Get sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}","href":"/api-reference/compute/get-sandbox"},{"title":"Update sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /sandboxes/{sandboxName}","href":"/api-reference/compute/update-sandbox"},{"title":"Delete sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}","href":"/api-reference/compute/delete-sandbox"},{"title":"Archive sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/archive","href":"/api-reference/compute/archive-sandbox"},{"title":"Fork sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/fork","href":"/api-reference/compute/fork-sandbox"},{"title":"List Sandbox Previews","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/previews","href":"/api-reference/compute/list-sandbox-previews"},{"title":"Create Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/previews","href":"/api-reference/compute/create-sandbox-preview"},{"title":"Get Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/previews/{previewName}","href":"/api-reference/compute/get-sandbox-preview"},{"title":"Update Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /sandboxes/{sandboxName}/previews/{previewName}","href":"/api-reference/compute/update-sandbox-preview"},{"title":"Delete Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}/previews/{previewName}","href":"/api-reference/compute/delete-sandbox-preview"},{"title":"Get tokens for Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/previews/{previewName}/tokens","href":"/api-reference/compute/get-tokens-for-sandbox-preview"},{"title":"Create token for Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/previews/{previewName}/tokens","href":"/api-reference/compute/create-token-for-sandbox-preview"},{"title":"Delete token for Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}/previews/{previewName}/tokens/{tokenName}","href":"/api-reference/compute/delete-token-for-sandbox-preview"},{"title":"List Sandbox Schedule Executions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/schedule-executions","href":"/api-reference/compute/list-sandbox-schedule-executions"},{"title":"List Sandbox Schedules","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/schedules","href":"/api-reference/compute/list-sandbox-schedules"},{"title":"Create Sandbox Schedule","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/schedules","href":"/api-reference/compute/create-sandbox-schedule"},{"title":"Get Sandbox Schedule","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/schedules/{scheduleId}","href":"/api-reference/compute/get-sandbox-schedule"},{"title":"Update Sandbox Schedule","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /sandboxes/{sandboxName}/schedules/{scheduleId}","href":"/api-reference/compute/update-sandbox-schedule"},{"title":"Delete Sandbox Schedule","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}/schedules/{scheduleId}","href":"/api-reference/compute/delete-sandbox-schedule"},{"title":"List sandbox snapshots","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/snapshots","href":"/api-reference/compute/list-sandbox-snapshots"},{"title":"Create sandbox snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/snapshots","href":"/api-reference/compute/create-sandbox-snapshot"},{"title":"Delete sandbox snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}/snapshots/{snapshotId}","href":"/api-reference/compute/delete-sandbox-snapshot"},{"title":"Restore sandbox from snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/snapshots/{snapshotId}/restore","href":"/api-reference/compute/restore-sandbox-from-snapshot"},{"title":"Unarchive sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/unarchive","href":"/api-reference/compute/unarchive-sandbox"},{"title":"Get sandbox by external ID","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/by-external-id/{externalId}","href":"/api-reference/compute/get-sandbox-by-external-id"},{"title":"List Workspace Schedule Executions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /schedule-executions","href":"/api-reference/compute/list-workspace-schedule-executions"},{"title":"List Workspace Schedules","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /schedules","href":"/api-reference/compute/list-workspace-schedules"},{"title":"Get Sandbox Scheduling Metrics","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /schedules/metrics","href":"/api-reference/compute/get-sandbox-scheduling-metrics"},{"title":"List snapshots","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /snapshots","href":"/api-reference/compute/list-snapshots"},{"title":"Create snapshot","description":"Captures a snapshot from a source object. The snapshot belongs to the workspace rather than to its source, so it survives the deletion of the object it was captured from, and carries what creating a sandbox or an application from it needs.","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /snapshots","href":"/api-reference/compute/create-snapshot"},{"title":"Get snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /snapshots/{snapshotName}","href":"/api-reference/compute/get-snapshot"},{"title":"Delete snapshot","description":"Deletes a snapshot. There is a single snapshot object, so this removes it for the whole workspace, whether or not the object it was captured from still exists.","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /snapshots/{snapshotName}","href":"/api-reference/compute/delete-snapshot"},{"title":"Fork snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /snapshots/{snapshotName}/fork","href":"/api-reference/compute/fork-snapshot"}]},{"group":"secrets","pages":[{"title":"List secrets","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /secrets","href":"/api-reference/secrets/list-secrets"},{"title":"Upsert secret","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /secrets","href":"/api-reference/secrets/upsert-secret"},{"title":"Delete secret by query","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /secrets","href":"/api-reference/secrets/delete-secret-by-query"},{"title":"Delete secret","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /secrets/{secretName}","href":"/api-reference/secrets/delete-secret"}]},{"group":"service_accounts","pages":[{"title":"List service accounts","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /service_accounts","href":"/api-reference/service_accounts/list-service-accounts"},{"title":"Create service account","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /service_accounts","href":"/api-reference/service_accounts/create-service-account"},{"title":"Update service account","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /service_accounts/{clientId}","href":"/api-reference/service_accounts/update-service-account"},{"title":"Delete service account","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /service_accounts/{clientId}","href":"/api-reference/service_accounts/delete-service-account"},{"title":"List service account API keys","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /service_accounts/{clientId}/api_keys","href":"/api-reference/service_accounts/list-service-account-api-keys"},{"title":"Create service account API key","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /service_accounts/{clientId}/api_keys","href":"/api-reference/service_accounts/create-service-account-api-key"},{"title":"Revoke service account API key","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /service_accounts/{clientId}/api_keys/{apiKeyId}","href":"/api-reference/service_accounts/revoke-service-account-api-key"}]},{"group":"templates","pages":[{"title":"List deployment templates","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /templates","href":"/api-reference/templates/list-deployment-templates"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /templates/{templateName}","href":"/api-reference/templates/get-template"}]},{"group":"volumeTemplates","pages":[{"title":"List volume templates","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volume_templates","href":"/api-reference/volumetemplates/list-volume-templates"},{"title":"Create volume template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /volume_templates","href":"/api-reference/volumetemplates/create-volume-template"},{"title":"Get volume template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volume_templates/{volumeTemplateName}","href":"/api-reference/volumetemplates/get-volume-template"},{"title":"Create or update volume template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /volume_templates/{volumeTemplateName}","href":"/api-reference/volumetemplates/create-or-update-volume-template"},{"title":"Delete volume template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /volume_templates/{volumeTemplateName}","href":"/api-reference/volumetemplates/delete-volume-template"},{"title":"Delete volume template version","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /volume_templates/{volumeTemplateName}/versions/{versionName}","href":"/api-reference/volumetemplates/delete-volume-template-version"}]},{"group":"volumes","pages":[{"title":"List persistent volumes","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volumes","href":"/api-reference/volumes/list-persistent-volumes"},{"title":"Create persistent volume","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /volumes","href":"/api-reference/volumes/create-persistent-volume"},{"title":"Get persistent volume","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volumes/{volumeName}","href":"/api-reference/volumes/get-persistent-volume"},{"title":"Update volume","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /volumes/{volumeName}","href":"/api-reference/volumes/update-volume"},{"title":"Delete persistent volume","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /volumes/{volumeName}","href":"/api-reference/volumes/delete-persistent-volume"},{"title":"Get volume by external ID","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volumes/by-external-id/{externalId}","href":"/api-reference/volumes/get-volume-by-external-id"}]}]}]},{"tab":"Sandbox API Reference","pages":[{"title":"Sandbox API Reference","href":"/api-reference/archive/export-the-filesystem-changes-to-a-presigned-url"}]},{"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"}]}]},"title":"Get snapshot - Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-BVNUlwBc.js","dist-aeztFa9U.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-rL8ZCCw4.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","AssistantPageLink-BywkCr5C.js"]}