Transitions the sandbox to the paused state. The underlying sandbox VM is
frozen and memory is preserved. Paused sandboxes do not consume CPU resources.Returns {"paused": true, "sandbox_id": "<id>"} on success.
Resume the sandbox with POST /sandboxes/{sandbox_id}/resume.
A sandbox created with lifecycle.on_timeout: "pause" is paused this same way
when its timeout fires, instead of being killed.
Sandbox is not in a state that can be paused. With code: pause_in_progress, another pause or restore of it is still running (possibly a pause its timeout triggered): wait for Retry-After and retry
500
Pause succeeded on orchestrator but Postgres state update failed
502
Orchestrator unreachable or returned non-200
503
No orchestrator available for the sandbox
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Declaw","description":"Declaw is a security-first sandbox platform for AI agents. Run untrusted code in sandbox microVMs with PII redaction, prompt injection defense, and network policy enforcement.","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/declaw/YB_0u8lW6K_x_PnD/logo/light.svg?fit=max\u0026auto=format\u0026n=YB_0u8lW6K_x_PnD\u0026q=85\u0026s=3a1b3b5d14a7c974db1eda0b8d012499","dark":"https://mintcdn.com/declaw/YB_0u8lW6K_x_PnD/logo/dark.svg?fit=max\u0026auto=format\u0026n=YB_0u8lW6K_x_PnD\u0026q=85\u0026s=564cdf5bfb8abed1949842b56312a3ba"},"favicon":"https://mintcdn.com/declaw/8XHgD2oahu7LIUrQ/favicon.svg?fit=max\u0026auto=format\u0026n=8XHgD2oahu7LIUrQ\u0026q=85\u0026s=c8814a2fdcc2cf40add79906afcd7b5b","api":{"openapi":"openapi.yaml","mdx":{"auth":{"method":"key","name":"X-API-Key"},"server":"https://api.declaw.ai"}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://docs.declaw.ai/mcp","label":"MCP"}],"primary":{"type":"button","label":"Get API Key","href":"https://declaw.ai"}},"footer":{"socials":{"x":"https://x.com/declaw_ai"}},"seo":{"indexing":"navigable"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/bjA5Zs9ZPw"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"declaw","hasAudioNarration":false,"actualSubdomain":"declaw","customDomains":["docs.declaw.ai"],"gitSource":{"type":"github","owner":"declaw-ai","repo":"declaw-cloud","deployBranch":"main","contentDirectory":"declaw/client_docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad8419f3fe31fb23d51dad1","collectionId":"dfe2e9f0-4a4f-4b22-8ebd-61b3d1c12780","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad8419f3fe31fb23d51dad1"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad8419f3fe31fb23d51dad1","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Cookbook","count":89},{"language":"default","tag":"API Reference","count":52},{"language":"default","tag":"Documentation","count":45},{"language":"default","tag":"SDKs","count":32},{"language":"default","tag":"Volumes API","count":21},{"language":"default","tag":"Sandbox API","count":14},{"language":"default","tag":"OpenAI Agents","count":14},{"language":"default","tag":"Security","count":13},{"language":"default","tag":"Python SDK","count":12},{"language":"default","tag":"Filesystem API","count":11}]},"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sandbox/pause","slug":"/api-reference/sandbox/pause","pageMetadata":{"title":"Pause Sandbox","api":"POST /sandboxes/{sandbox_id}/pause","description":"Freeze a running sandbox, preserving its in-memory state.","href":"/api-reference/sandbox/pause"},"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: \"Freeze a running sandbox, preserving its in-memory state.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Note,ParamField,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Transitions the sandbox to the `,_jsx(_components.code,{children:`paused`}),` state. The underlying sandbox VM is\nfrozen and memory is preserved. Paused sandboxes do not consume CPU resources.`]}),`\n`,_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`{\"paused\": true, \"sandbox_id\": \"\u003cid>\"}`}),` on success.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Resume the sandbox with `,_jsx(_components.a,{href:`/api-reference/sandbox/resume`,children:_jsx(_components.code,{children:`POST /sandboxes/{sandbox_id}/resume`})}),`.\nA sandbox created with `,_jsx(_components.code,{children:`lifecycle.on_timeout: \"pause\"`}),` is paused this same way\nwhen its timeout fires, instead of being killed.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`sandbox_id`,type:`string`,required:true,id:`param-sandbox-id`,children:_jsxs(_components.p,{children:[`The sandbox identifier. Format: `,_jsx(_components.code,{children:`sbx-\u003c8 chars>`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`paused`,type:`boolean`,id:`param-paused`,children:_jsxs(_components.p,{children:[`Always `,_jsx(_components.code,{children:`true`}),` on success.`]})}),`\n`,_jsx(ResponseField,{name:`sandbox_id`,type:`string`,id:`param-sandbox-id-1`,children:_jsx(_components.p,{children:`The paused sandbox’s identifier.`})}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.declaw.ai/sandboxes/sbx-a1b2c3d4/pause`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key: YOUR_API_KEY\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`5`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` declaw `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Sandbox`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`sbx `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Sandbox.connect(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sbx-a1b2c3d4\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`domain`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"api.declaw.ai\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`sbx.pause()`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# sbx.state is now \"paused\"`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`TypeScript`,numberOfLines:`7`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Sandbox`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"@declaw/sdk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` sbx`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` Sandbox`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`connect`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sbx-a1b2c3d4\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` apiKey:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` domain:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"api.declaw.ai\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` sbx`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`pause`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`]})})})]}),`\n`,_jsx(CodeBlock,{filename:`Response`,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"paused\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"sandbox_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sbx-a1b2c3d4\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error Responses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Missing or invalid API key`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`Sandbox not found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsxs(_components.td,{children:[`Sandbox is not in a state that can be paused. With `,_jsx(_components.code,{children:`code: pause_in_progress`}),`, another pause or restore of it is still running (possibly a pause its timeout triggered): wait for `,_jsx(_components.code,{children:`Retry-After`}),` and retry`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Pause succeeded on orchestrator but Postgres state update failed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`502`})}),_jsx(_components.td,{children:`Orchestrator unreachable or returned non-200`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:`No orchestrator available for the sandbox`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Pause Sandbox","api":"POST /sandboxes/{sandbox_id}/pause","description":"Freeze a running sandbox, preserving its in-memory state.","href":"/api-reference/sandbox/pause"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Path Parameters","slug":"path-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Example","slug":"example","depth":2,"children":[]},{"title":"Error Responses","slug":"error-responses","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Pause Sandbox","path":"/sandboxes/{sandbox_id}/pause","servers":[{"url":"https://api.declaw.ai"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"X-API-Key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"sandbox_id":{"schema":[{"type":"string","description":"The sandbox identifier. Format: `sbx-\u003c8 chars>` .","required":true}]}}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"paused":[{"type":"boolean","description":"Always `true` on success."}],"sandbox_id":[{"type":"string","description":"The paused sandbox’s identifier."}]}}],"examples":{"example":{"value":{"paused":true,"sandbox_id":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"declaw","siteName":"Declaw","title":"Pause Sandbox - Declaw","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-17T12:29:26.700Z","originalFileLocation":"api-reference/sandbox/pause.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=\"dark\"}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=\"Freeze a running sandbox, preserving its in-memory state.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Declaw\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/declaw/5qZO9alYltiMvEad/_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/declaw/5qZO9alYltiMvEad/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/declaw/5qZO9alYltiMvEad/_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/declaw/5qZO9alYltiMvEad/_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/declaw/5qZO9alYltiMvEad/_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/declaw/5qZO9alYltiMvEad/_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/declaw/5qZO9alYltiMvEad/_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/declaw/5qZO9alYltiMvEad/_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/declaw/5qZO9alYltiMvEad/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Pause Sandbox - Declaw\">\u003cmeta data-mint-head property=\"og:description\" content=\"Freeze a running sandbox, preserving its in-memory state.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Declaw\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.declaw.ai/api-reference/sandbox/pause\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://declaw.mintlify.app/_mintlify/api/og/v2?division=Sandbox+API\u0026amp;title=Pause+Sandbox\u0026amp;description=Freeze+a+running+sandbox%2C+preserving+its+in-memory+state.\u0026amp;theme=e908f26a500811980d5ccfa6\u0026amp;signature=71096e37033e9565d051da8ee39fff1c3e39e887b4dd2c5e455f023fabf1bf31\">\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=\"Pause Sandbox - Declaw\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Freeze a running sandbox, preserving its in-memory state.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://declaw.mintlify.app/_mintlify/api/og/v2?division=Sandbox+API\u0026amp;title=Pause+Sandbox\u0026amp;description=Freeze+a+running+sandbox%2C+preserving+its+in-memory+state.\u0026amp;theme=e908f26a500811980d5ccfa6\u0026amp;signature=71096e37033e9565d051da8ee39fff1c3e39e887b4dd2c5e455f023fabf1bf31\">\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/declaw/5qZO9alYltiMvEad/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Declaw\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.declaw.ai/api-reference/sandbox/pause\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sandbox/pause.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.declaw.ai/#organization\",\"name\":\"Declaw\",\"url\":\"https://docs.declaw.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/declaw/YB_0u8lW6K_x_PnD/logo/light.svg?fit=max\u0026auto=format\u0026n=YB_0u8lW6K_x_PnD\u0026q=85\u0026s=3a1b3b5d14a7c974db1eda0b8d012499\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.declaw.ai#website\",\"name\":\"Declaw\",\"url\":\"https://docs.declaw.ai\",\"publisher\":{\"@id\":\"https://docs.declaw.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.declaw.ai/api-reference/sandbox/pause#webpage\",\"url\":\"https://docs.declaw.ai/api-reference/sandbox/pause\",\"name\":\"Pause Sandbox\",\"description\":\"Freeze a running sandbox, preserving its in-memory state.\",\"dateModified\":\"2026-09-17T12:29:26.700Z\",\"isPartOf\":{\"@id\":\"https://docs.declaw.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.declaw.ai/api-reference/sandbox/pause#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.declaw.ai/api-reference/sandbox/pause#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sandbox API\",\"item\":\"https://docs.declaw.ai/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Pause Sandbox\",\"item\":\"https://docs.declaw.ai/api-reference/sandbox/pause\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.declaw.ai/api-reference/sandbox/pause#apireference\",\"headline\":\"Pause Sandbox\",\"name\":\"Pause Sandbox\",\"description\":\"Freeze a running sandbox, preserving its in-memory state.\",\"url\":\"https://docs.declaw.ai/api-reference/sandbox/pause\",\"mainEntityOfPage\":{\"@id\":\"https://docs.declaw.ai/api-reference/sandbox/pause#webpage\"},\"dateModified\":\"2026-09-17T12:29:26.700Z\",\"publisher\":{\"@id\":\"https://docs.declaw.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.declaw.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Declaw\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Declaw","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/bjA5Zs9ZPw"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Sandbox API","pages":[{"title":"API Overview","sidebarTitle":"Overview","href":"/api-reference/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"Create Sandbox","api":"POST /sandboxes","href":"/api-reference/sandbox/create"},{"title":"List Sandboxes","api":"GET /sandboxes","href":"/api-reference/sandbox/list"},{"title":"Get Sandbox","api":"GET /sandboxes/{sandbox_id}","href":"/api-reference/sandbox/get"},{"title":"Kill Sandbox","api":"DELETE /sandboxes/{sandbox_id}","href":"/api-reference/sandbox/kill"},{"title":"Get Sandbox Status","api":"GET /sandboxes/{sandbox_id}/status","href":"/api-reference/sandbox/status"},{"title":"Set Timeout","api":"PATCH /sandboxes/{sandbox_id}/timeout","description":"Update the timeout for a running sandbox.","href":"/api-reference/sandbox/set-timeout"},{"title":"Pause Sandbox","api":"POST /sandboxes/{sandbox_id}/pause","href":"/api-reference/sandbox/pause"},{"title":"Resume Sandbox","api":"POST /sandboxes/{sandbox_id}/resume","description":"Resume a paused sandbox from its most recent pause snapshot.","href":"/api-reference/sandbox/resume"},{"title":"Create Snapshot","api":"POST /sandboxes/{sandbox_id}/snapshot","href":"/api-reference/sandbox/create-snapshot"},{"title":"List Snapshots","api":"GET /sandboxes/{sandbox_id}/snapshots","href":"/api-reference/sandbox/list-snapshots"},{"title":"Restore Sandbox","api":"POST /sandboxes/{sandbox_id}/restore","href":"/api-reference/sandbox/restore"},{"title":"Fork Sandbox","api":"POST /sandboxes/{sandbox_id}/fork","href":"/api-reference/sandbox/fork"}]},{"group":"Command API","pages":[{"title":"Run Command","api":"POST /sandboxes/{sandbox_id}/commands","href":"/api-reference/command/run"},{"title":"Run Command (Stream)","api":"POST /sandboxes/{sandbox_id}/commands/stream","href":"/api-reference/command/run-stream"},{"title":"List Commands","api":"GET /sandboxes/{sandbox_id}/commands","href":"/api-reference/command/list"},{"title":"Kill Command","api":"DELETE /sandboxes/{sandbox_id}/commands/{pid}","href":"/api-reference/command/kill"},{"title":"Send Stdin","api":"POST /sandboxes/{sandbox_id}/commands/{pid}/stdin","href":"/api-reference/command/send-stdin"},{"title":"Wait for Command","api":"GET /sandboxes/{sandbox_id}/commands/{pid}/wait","href":"/api-reference/command/wait"}]},{"group":"Filesystem API","pages":[{"title":"Read File","api":"GET /sandboxes/{sandbox_id}/files","href":"/api-reference/filesystem/read"},{"title":"Write File","api":"POST /sandboxes/{sandbox_id}/files","href":"/api-reference/filesystem/write"},{"title":"Write File (Raw / Binary)","api":"PUT /sandboxes/{sandbox_id}/files/raw","href":"/api-reference/filesystem/write-raw"},{"title":"Write Files (Batch)","api":"POST /sandboxes/{sandbox_id}/files/batch","href":"/api-reference/filesystem/write-batch"},{"title":"List Directory","api":"GET /sandboxes/{sandbox_id}/files/list","href":"/api-reference/filesystem/list-dir"},{"title":"File Exists","api":"GET /sandboxes/{sandbox_id}/files/exists","href":"/api-reference/filesystem/exists"},{"title":"File Info","api":"GET /sandboxes/{sandbox_id}/files/info","href":"/api-reference/filesystem/info"},{"title":"Remove File","api":"DELETE /sandboxes/{sandbox_id}/files","href":"/api-reference/filesystem/remove"},{"title":"Rename / Move File","api":"PATCH /sandboxes/{sandbox_id}/files","href":"/api-reference/filesystem/rename"},{"title":"Make Directory","api":"POST /sandboxes/{sandbox_id}/files/mkdir","href":"/api-reference/filesystem/mkdir"},{"title":"Watch Directory","api":"POST /sandboxes/{sandbox_id}/files/watch","href":"/api-reference/filesystem/watch"}]},{"group":"Volumes API","pages":[{"title":"Create Volume","api":"POST /volumes","href":"/api-reference/volumes/create"},{"title":"List Volumes","api":"GET /volumes","href":"/api-reference/volumes/list"},{"title":"Get Volume","api":"GET /volumes/{volume_id}","href":"/api-reference/volumes/get"},{"title":"Delete Volume","api":"DELETE /volumes/{volume_id}","href":"/api-reference/volumes/delete"},{"title":"Download Volume","api":"GET /volumes/{volume_id}/download","href":"/api-reference/volumes/download"},{"title":"Create Empty Volume","api":"POST /volumes/empty","href":"/api-reference/volumes/create-empty"},{"title":"Ingest Volume","api":"POST /volumes/ingest","href":"/api-reference/volumes/ingest"},{"title":"Read Volume File","api":"GET /volumes/{volume_id}/files/raw","href":"/api-reference/volumes/read-file"},{"title":"Write Volume File","api":"PUT /volumes/{volume_id}/files/raw","href":"/api-reference/volumes/write-file"},{"title":"List Volume Directory","api":"GET /volumes/{volume_id}/files/list","href":"/api-reference/volumes/list-files"},{"title":"Stat Volume File","api":"GET /volumes/{volume_id}/files/info","href":"/api-reference/volumes/stat-file"},{"title":"Volume File Exists","api":"GET /volumes/{volume_id}/files/exists","href":"/api-reference/volumes/file-exists"},{"title":"Make Volume Directory","api":"POST /volumes/{volume_id}/files/mkdir","href":"/api-reference/volumes/mkdir"},{"title":"Remove Volume File","api":"DELETE /volumes/{volume_id}/files","href":"/api-reference/volumes/remove"},{"title":"Rename Volume File","api":"PATCH /volumes/{volume_id}/files","href":"/api-reference/volumes/rename"},{"title":"Acquire Volume Lock","api":"POST /volumes/{volume_id}/locks","href":"/api-reference/volumes/acquire-lock"},{"title":"Get Volume Lock Status","api":"GET /volumes/{volume_id}/locks","href":"/api-reference/volumes/lock-status"},{"title":"Renew Volume Lock","api":"POST /volumes/{volume_id}/locks/renew","href":"/api-reference/volumes/renew-lock"},{"title":"Release Volume Lock","api":"DELETE /volumes/{volume_id}/locks","href":"/api-reference/volumes/release-lock"},{"title":"Commit Attached Volume","api":"POST /sandboxes/{sandbox_id}/volumes/{volume_id}/commit","href":"/api-reference/volumes/commit"},{"title":"Snapshot Sandbox Path","api":"POST /sandboxes/{sandbox_id}/volumes/snapshot","href":"/api-reference/volumes/snapshot"}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/python/overview"}]},{"tab":"Cookbook","pages":[{"title":"Cookbook","href":"/cookbook/overview"}]}]},"title":"Pause Sandbox - Declaw","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["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"]}