Returns sandboxes belonging to the authenticated team, ordered by
creation time (newest first) by default.
Pagination, sorting, and search
Pass limit (and offset) to fetch one page at a time; the
X-Total-Count response header reports the total across all pages.
Omitting limit returns the full list, so existing unpaginated
callers are unaffected. Sort with sort + order, filter by exact
status (one value or comma-separated values), and search names with q (case-insensitive substring).
Filtering by metadata
Any query parameter prefixed metadata. is treated as a filter
clause: ?metadata.env=prod&metadata.owner=agent-7. Multiple
filters AND together — a sandbox matches only if every key/value
pair is present in its metadata. Values are compared as exact
strings; there is no type coercion or substring matching.
GET
/
sandboxes
List all sandboxes
curl --request GET \
--url https://api.superserve.ai/sandboxes \
--header 'X-API-Key: <api-key>'
Filter sandboxes whose metadata contains an exact {key}: <value>
pair. Repeat with different keys to AND multiple filters. Values
are always strings. Example: ?metadata.env=prod.
Match any selected status, for example status=active,starting,resuming.
A single status and repeated status parameters are also accepted.
Omit or pass a single empty value for no filter. Unknown values or
empty entries in a multiple-status filter are a 400.
Maximum rows to return (page size). Omit to return the full list
unpaginated — the default, preserved for backward compatibility with
callers that page client-side. Values above 200 are clamped to 200.
Public sandbox ID: a bare UUID, or the region-tagged form sb-<region>-<uuid> (e.g. sb-use-1b4e28ba-…). Treat as an opaque string; the tagged form routes the request to the sandbox's home region. Endpoints accept both forms interchangeably.
Current state of the sandbox. active means running; paused means paused and awaiting resume. pausing, resuming and migrating are transient states observed while the platform pauses, restores, or relocates a sandbox (e.g. after a 202 from /pause, or auto-resume on /exec); clients should poll or retry shortly. failed means the sandbox can no longer be resumed.
When the sandbox will be deleted. Present only while the sandbox is paused with auto_delete_seconds configured. The deadline is armed when the sandbox pauses (or when the setting is applied to an already-paused sandbox) and cleared on resume.
Default access for newly published ports. public and private
are strict modes; existing published rows keep their own access.
legacy_public may be returned for an older sandbox and preserves
all-port behavior until updated to a strict mode.
Available options:
legacy_public,
public,
private
⌘I
List all sandboxes
curl --request GET \
--url https://api.superserve.ai/sandboxes \
--header 'X-API-Key: <api-key>'
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Superserve","colors":{"primary":"#B2FAB4","light":"#B2FAB4","dark":"#B2FAB4"},"logo":"https://mintcdn.com/superserve-ai-superserve-33/G055TX3BjwXpQedU/logo.svg?fit=max\u0026auto=format\u0026n=G055TX3BjwXpQedU\u0026q=85\u0026s=69233fb550a17b81d7d7fa083ca7f3de","favicon":"https://mintcdn.com/superserve-ai-superserve-33/G055TX3BjwXpQedU/favicon.svg?fit=max\u0026auto=format\u0026n=G055TX3BjwXpQedU\u0026q=85\u0026s=5c49ee9ed883d587b192cd419a4747d8","appearance":{"default":"dark","strict":true},"background":{"decoration":"gradient","color":{"dark":"#141414"}},"navbar":{"links":[{"href":"https://github.com/superserve-ai/superserve","label":"GitHub","type":"github"}],"primary":{"type":"button","label":"Get Started","href":"https://console.superserve.ai/auth/signup/?utm_source=docs\u0026utm_medium=navbar"}},"footer":{"socials":{"x":"https://x.com/superserve_ai","github":"https://github.com/superserve-ai","linkedin":"https://www.linkedin.com/company/super-serve-ai"},"links":[{"header":"Resources","items":[{"label":"Status","href":"https://status.superserve.ai"}]}]},"fonts":{"heading":{"family":"Instrument Sans"},"body":{"family":"Instrument Sans"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"vitesse-dark"}},"latex":false},"integrations":{"posthog":{"apiKey":"phc_gjpDKKKQJAnkxkqLrPGrAhoariKsaHNuTpI5rVhkYre","apiHost":"https://p.superserve.ai"}},"contextual":{"options":["copy","view","claude","mcp","add-mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"superserve-ai-superserve-33","hasAudioNarration":false,"actualSubdomain":"superserve-ai-superserve-33","customDomains":["docs.superserve.ai"],"gitSource":{"type":"github","owner":"superserve-ai","repo":"superserve","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec322c25c041b786077789","collectionId":"79e56834-76ad-435e-a8ed-f6ef6b1592de","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec322c25c041b786077789"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee45fff52394cd3f372a82","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"REST API","count":51},{"language":"default","tag":"Documentation","count":31},{"language":"default","tag":"Integrations","count":17},{"language":"default","tag":"Sandboxes","count":14},{"language":"default","tag":"Templates","count":13},{"language":"default","tag":"Sandbox","count":10},{"language":"default","tag":"Secrets","count":10},{"language":"default","tag":"SDK Reference","count":6},{"language":"default","tag":"Reference","count":6},{"language":"default","tag":"Team Management","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/sandboxes/list-all-sandboxes","slug":"/api-reference/sandboxes/list-all-sandboxes","pageMetadata":{"title":"List all sandboxes","description":"Returns sandboxes belonging to the authenticated team, ordered by\ncreation time (newest first) by default.\n\n## Pagination, sorting, and search\n\nPass `limit` (and `offset`) to fetch one page at a time; the\n`X-Total-Count` response header reports the total across all pages.\nOmitting `limit` returns the full list, so existing unpaginated\ncallers are unaffected. Sort with `sort` + `order`, filter by exact\n`status` (one value or comma-separated values), and search names with `q` (case-insensitive substring).\n\n## Filtering by metadata\n\nAny query parameter prefixed `metadata.` is treated as a filter\nclause: `?metadata.env=prod\u0026metadata.owner=agent-7`. Multiple\nfilters AND together — a sandbox matches only if every key/value\npair is present in its metadata. Values are compared as exact\nstrings; there is no type coercion or substring matching.\n","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /sandboxes","href":"/api-reference/sandboxes/list-all-sandboxes","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h2: \"h2\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns sandboxes belonging to the authenticated team, ordered by\\ncreation time (newest first) by default.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Pagination, sorting, and search\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Pass \", _jsx(_components.code, {\n children: \"limit\"\n }), \" (and \", _jsx(_components.code, {\n children: \"offset\"\n }), \") to fetch one page at a time; the\\n\", _jsx(_components.code, {\n children: \"X-Total-Count\"\n }), \" response header reports the total across all pages.\\nOmitting \", _jsx(_components.code, {\n children: \"limit\"\n }), \" returns the full list, so existing unpaginated\\ncallers are unaffected. Sort with \", _jsx(_components.code, {\n children: \"sort\"\n }), \" + \", _jsx(_components.code, {\n children: \"order\"\n }), \", filter by exact\\n\", _jsx(_components.code, {\n children: \"status\"\n }), \" (one value or comma-separated values), and search names with \", _jsx(_components.code, {\n children: \"q\"\n }), \" (case-insensitive substring).\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Filtering by metadata\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Any query parameter prefixed \", _jsx(_components.code, {\n children: \"metadata.\"\n }), \" is treated as a filter\\nclause: \", _jsx(_components.code, {\n children: \"?metadata.env=prod\u0026metadata.owner=agent-7\"\n }), \". Multiple\\nfilters AND together — a sandbox matches only if every key/value\\npair is present in its metadata. Values are compared as exact\\nstrings; there is no type coercion or substring matching.\"]\n })]\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":{"codeStyling":{"theme":{"light":"github-light","dark":"vitesse-dark"}},"config":{},"pageMetadata":{"title":"List all sandboxes","description":"Returns sandboxes belonging to the authenticated team, ordered by\ncreation time (newest first) by default.\n\n## Pagination, sorting, and search\n\nPass `limit` (and `offset`) to fetch one page at a time; the\n`X-Total-Count` response header reports the total across all pages.\nOmitting `limit` returns the full list, so existing unpaginated\ncallers are unaffected. Sort with `sort` + `order`, filter by exact\n`status` (one value or comma-separated values), and search names with `q` (case-insensitive substring).\n\n## Filtering by metadata\n\nAny query parameter prefixed `metadata.` is treated as a filter\nclause: `?metadata.env=prod\u0026metadata.owner=agent-7`. Multiple\nfilters AND together — a sandbox matches only if every key/value\npair is present in its metadata. Values are compared as exact\nstrings; there is no type coercion or substring matching.\n","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /sandboxes","href":"/api-reference/sandboxes/list-all-sandboxes","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listSandboxes","tags":["Sandboxes"],"summary":"List all sandboxes","description":"Returns sandboxes belonging to the authenticated team, ordered by\ncreation time (newest first) by default.\n\n## Pagination, sorting, and search\n\nPass `limit` (and `offset`) to fetch one page at a time; the\n`X-Total-Count` response header reports the total across all pages.\nOmitting `limit` returns the full list, so existing unpaginated\ncallers are unaffected. Sort with `sort` + `order`, filter by exact\n`status` (one value or comma-separated values), and search names with `q` (case-insensitive substring).\n\n## Filtering by metadata\n\nAny query parameter prefixed `metadata.` is treated as a filter\nclause: `?metadata.env=prod\u0026metadata.owner=agent-7`. Multiple\nfilters AND together — a sandbox matches only if every key/value\npair is present in its metadata. Values are compared as exact\nstrings; there is no type coercion or substring matching.\n","security":["04125dfc-989d-43a4-ad20-c0ee9583000c"],"parameters":["010e2386-8a2b-4f94-8086-45c49acc27d4","d2b4c5e5-7c21-4457-914c-a4e3107e0e3c","1aa050fb-5904-435c-a4dc-5d0d77891d3c","5ce33d7d-2be2-45fd-9db1-f80ce09bbbab","bbc9367a-02d6-41c3-9fec-e5cc64446699","306d7dd4-525b-4a09-a799-1ffdd8a33d0c","b0dd967b-f909-4ffe-9367-42af941c2762"],"responses":{"200":"3a4ec0ac-1002-4aa6-8ea9-1c7436b7cf2d","400":"77a0fea7-8780-478d-9e28-ed02d97b38a9","401":"7ff0c520-03e9-4b27-a23e-fa21378b4377","429":"d0ecfe7b-5dbe-46cb-9cbe-5002d1dfb326","500":"28824117-6467-4870-b49e-686f4dd86f9f"},"method":"get","type":"path","servers":["f85ef4dd-1352-4cb0-b282-bdf1a80e91dc"],"path":"/sandboxes","baseUrlOptions":["https://api.superserve.ai"],"title":"List all sandboxes","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"010e2386-8a2b-4f94-8086-45c49acc27d4":{"name":"metadata.{key}","in":"query","required":false,"description":"Filter sandboxes whose metadata contains an exact `{key}: \u003cvalue>`\npair. Repeat with different keys to AND multiple filters. Values\nare always strings. Example: `?metadata.env=prod`.\n","schema":{"type":"string","isRequired":false,"description":"Filter sandboxes whose metadata contains an exact `{key}: \u003cvalue>`\npair. Repeat with different keys to AND multiple filters. Values\nare always strings. Example: `?metadata.env=prod`.\n","uniqueKey":"","typeLabel":"string"}},"d2b4c5e5-7c21-4457-914c-a4e3107e0e3c":{"name":"q","in":"query","required":false,"description":"Case-insensitive substring match on the resource `name`.","schema":{"type":"string","isRequired":false,"description":"Case-insensitive substring match on the resource `name`.","uniqueKey":"","typeLabel":"string"}},"1aa050fb-5904-435c-a4dc-5d0d77891d3c":{"name":"status","in":"query","required":false,"description":"Match any selected status, for example `status=active,starting,resuming`.\nA single status and repeated `status` parameters are also accepted.\nOmit or pass a single empty value for no filter. Unknown values or\nempty entries in a multiple-status filter are a `400`.\n","style":"form","explode":false,"schema":{"type":"array","minItems":1,"items":{"type":"string","enum":["starting","active","pausing","paused","resuming","migrating","failed","deleted"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Match any selected status, for example `status=active,starting,resuming`.\nA single status and repeated `status` parameters are also accepted.\nOmit or pass a single empty value for no filter. Unknown values or\nempty entries in a multiple-status filter are a `400`.\n","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"5ce33d7d-2be2-45fd-9db1-f80ce09bbbab":{"name":"sort","in":"query","required":false,"description":"Column to sort by (paired with `order`).","schema":{"type":"string","enum":["created_at","name","status"],"default":"created_at","isRequired":false,"description":"Column to sort by (paired with `order`).","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"bbc9367a-02d6-41c3-9fec-e5cc64446699":{"name":"order","in":"query","required":false,"description":"Sort direction applied to `sort`.","schema":{"type":"string","enum":["asc","desc"],"default":"desc","isRequired":false,"description":"Sort direction applied to `sort`.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"306d7dd4-525b-4a09-a799-1ffdd8a33d0c":{"name":"limit","in":"query","required":false,"description":"Maximum rows to return (page size). Omit to return the full list\nunpaginated — the default, preserved for backward compatibility with\ncallers that page client-side. Values above 200 are clamped to 200.\n","schema":{"type":"integer","minimum":1,"maximum":200,"isRequired":false,"description":"Maximum rows to return (page size). Omit to return the full list\nunpaginated — the default, preserved for backward compatibility with\ncallers that page client-side. Values above 200 are clamped to 200.\n","uniqueKey":"","typeLabel":"integer"}},"b0dd967b-f909-4ffe-9367-42af941c2762":{"name":"offset","in":"query","required":false,"description":"Rows to skip before the page. Combine with `limit` to paginate.","schema":{"type":"integer","minimum":0,"default":0,"isRequired":false,"description":"Rows to skip before the page. Combine with `limit` to paginate.","uniqueKey":"","typeLabel":"integer"}}},"responses":{"3a4ec0ac-1002-4aa6-8ea9-1c7436b7cf2d":{"description":"List of sandboxes belonging to the authenticated team","headers":{"X-Total-Count":{"description":"Total rows matching the query across all pages, ignoring `limit` and\n`offset`. Read this alongside a `limit`/`offset` request to render\npagination controls (page count, \"X–Y of Z\").\n","schema":{"type":"integer","format":"int64"}}},"content":{"application/json":{"schema":{"type":"array","items":{"description":"Sandbox shape returned by list endpoints.","type":"object","properties":{"id":{"type":"string","pattern":"^(sb-[a-z0-9]+-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Public sandbox ID: a bare UUID, or the region-tagged form `sb-\u003cregion>-\u003cuuid>` (e.g. `sb-use-1b4e28ba-…`). Treat as an opaque string; the tagged form routes the request to the sandbox's home region. Endpoints accept both forms interchangeably.\n","uniqueKey":"items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["active","pausing","paused","resuming","migrating","failed"],"description":"Current state of the sandbox. `active` means running; `paused` means paused and awaiting resume. `pausing`, `resuming` and `migrating` are transient states observed while the platform pauses, restores, or relocates a sandbox (e.g. after a `202` from `/pause`, or auto-resume on `/exec`); clients should poll or retry shortly. `failed` means the sandbox can no longer be resumed.\n","uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"vcpu_count":{"type":"integer","uniqueKey":"items.[INDEX].vcpu_count","typeLabel":"integer"},"memory_mib":{"type":"integer","uniqueKey":"items.[INDEX].memory_mib","typeLabel":"integer"},"snapshot_id":{"type":"string","format":"uuid","description":"ID of the latest snapshot (present after a pause).","uniqueKey":"items.[INDEX].snapshot_id","typeLabel":"string\u003cuuid>"},"source_snapshot_id":{"type":"string","format":"uuid","description":"The saved snapshot the sandbox was created from, when it was.","uniqueKey":"items.[INDEX].source_snapshot_id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","uniqueKey":"items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"timeout_seconds":{"type":"integer","format":"int32","description":"Auto-pause timeout in seconds, if configured. Absent when auto-pause is disabled.\n","uniqueKey":"items.[INDEX].timeout_seconds","typeLabel":"integer\u003cint32>"},"idle_timeout_seconds":{"type":"integer","format":"int32","description":"Idle timeout in seconds, if configured. Absent when the sandbox is never paused for being idle.\n","uniqueKey":"items.[INDEX].idle_timeout_seconds","typeLabel":"integer\u003cint32>"},"auto_delete_seconds":{"type":"integer","format":"int32","description":"Garbage-collection window for the paused state, if configured. Absent when auto-delete is disabled.\n","uniqueKey":"items.[INDEX].auto_delete_seconds","typeLabel":"integer\u003cint32>"},"auto_delete_at":{"type":"string","format":"date-time","description":"When the sandbox will be deleted. Present only while the sandbox is paused with `auto_delete_seconds` configured. The deadline is armed when the sandbox pauses (or when the setting is applied to an already-paused sandbox) and cleared on resume.\n","uniqueKey":"items.[INDEX].auto_delete_at","typeLabel":"string\u003cdate-time>"},"network":{"type":"object","description":"Current egress allow/deny rules, if any have been configured. Absent when the sandbox uses default network settings.\n","properties":{"allow_out":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].network.allow_out.items.[INDEX]","typeLabel":"string"},"description":"CIDRs or domains to allow.","example":["api.openai.com","*.github.com","8.8.8.8/32"],"uniqueKey":"items.[INDEX].network.allow_out","typeLabel":"string[]"},"deny_out":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].network.deny_out.items.[INDEX]","typeLabel":"string"},"description":"CIDRs to deny. Use `0.0.0.0/0` to block all traffic not in `allow_out`.","example":["0.0.0.0/0"],"uniqueKey":"items.[INDEX].network.deny_out","typeLabel":"string[]"}},"uniqueKey":"items.[INDEX].network","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"description":"User-supplied tags attached at creation. Always present — sandboxes created without metadata return `{}` rather than being absent.\n","example":{"env":"prod","owner":"agent-7"},"uniqueKey":"items.[INDEX].metadata","typeLabel":"object"},"preview_access":{"type":"string","enum":["legacy_public","public","private"],"description":"Default access for newly published ports. `public` and `private`\nare strict modes; existing published rows keep their own access.\n`legacy_public` may be returned for an older sandbox and preserves\nall-port behavior until updated to a strict mode.\n","uniqueKey":"items.[INDEX].preview_access","typeLabel":"enum\u003cstring>"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":"\u003cstring>","name":"\u003cstring>","status":"active","vcpu_count":123,"memory_mib":123,"snapshot_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","source_snapshot_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_at":"2023-11-07T05:31:56Z","timeout_seconds":123,"idle_timeout_seconds":123,"auto_delete_seconds":123,"auto_delete_at":"2023-11-07T05:31:56Z","network":{"allow_out":["api.openai.com","*.github.com","8.8.8.8/32"],"deny_out":["0.0.0.0/0"]},"metadata":{"env":"prod","owner":"agent-7"},"preview_access":"legacy_public"}]}},"exampleType":"generated"}},"exampleType":"generated"},"77a0fea7-8780-478d-9e28-ed02d97b38a9":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","description":"Error envelope. `error.code` is a stable, machine-readable identifier\n(e.g. `bad_request`, `not_found`, `conflict`, `sandbox_pausing`,\n`rate_limited`, `too_many_builds`, `too_many_templates`, `too_many_sandboxes`,\n`image_pull_failed`, `step_failed`, `snapshot_failed`,\n`start_cmd_failed`, `ready_cmd_failed`, `capacity_unavailable`,\n`build_timed_out`, `infrastructure_failed`, `build_failed`).\n`error.message` is human-readable and may change between releases;\nclients should branch on `code`, not `message`.\n","properties":{"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7ff0c520-03e9-4b27-a23e-fa21378b4377":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","description":"Error envelope. `error.code` is a stable, machine-readable identifier\n(e.g. `bad_request`, `not_found`, `conflict`, `sandbox_pausing`,\n`rate_limited`, `too_many_builds`, `too_many_templates`, `too_many_sandboxes`,\n`image_pull_failed`, `step_failed`, `snapshot_failed`,\n`start_cmd_failed`, `ready_cmd_failed`, `capacity_unavailable`,\n`build_timed_out`, `infrastructure_failed`, `build_failed`).\n`error.message` is human-readable and may change between releases;\nclients should branch on `code`, not `message`.\n","properties":{"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d0ecfe7b-5dbe-46cb-9cbe-5002d1dfb326":{"description":"Rate limit hit — the caller's per-team request budget is temporarily exhausted. Response body uses error code `rate_limited`. Retry after a short backoff; the bucket refills continuously.\n","content":{"application/json":{"schema":{"type":"object","description":"Error envelope. `error.code` is a stable, machine-readable identifier\n(e.g. `bad_request`, `not_found`, `conflict`, `sandbox_pausing`,\n`rate_limited`, `too_many_builds`, `too_many_templates`, `too_many_sandboxes`,\n`image_pull_failed`, `step_failed`, `snapshot_failed`,\n`start_cmd_failed`, `ready_cmd_failed`, `capacity_unavailable`,\n`build_timed_out`, `infrastructure_failed`, `build_failed`).\n`error.message` is human-readable and may change between releases;\nclients should branch on `code`, not `message`.\n","properties":{"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"28824117-6467-4870-b49e-686f4dd86f9f":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Error envelope. `error.code` is a stable, machine-readable identifier\n(e.g. `bad_request`, `not_found`, `conflict`, `sandbox_pausing`,\n`rate_limited`, `too_many_builds`, `too_many_templates`, `too_many_sandboxes`,\n`image_pull_failed`, `step_failed`, `snapshot_failed`,\n`start_cmd_failed`, `ready_cmd_failed`, `capacity_unavailable`,\n`build_timed_out`, `infrastructure_failed`, `build_failed`).\n`error.message` is human-readable and may change between releases;\nclients should branch on `code`, not `message`.\n","properties":{"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"04125dfc-989d-43a4-ad20-c0ee9583000c":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"apiKey"}}},"servers":{"f85ef4dd-1352-4cb0-b282-bdf1a80e91dc":{"url":"https://api.superserve.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"https://api.superserve.ai/openapi.yaml"},"subdomain":"superserve-ai-superserve-33","siteName":"Superserve","title":"List all sandboxes - Superserve","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T20:32:33.983Z","originalFileLocation":"api-reference/sandboxes/list-all-sandboxes.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"Returns sandboxes belonging to the authenticated team, ordered by creation time (newest first) by default. ## Pagination, sorting, and search Pass limit (and offset) to fetch one page at a time; the X-Total-Count response header reports the total across all pages. Omitting limit returns the full list, so existing unpaginated callers are unaffected. Sort with sort + order, filter by exact status (one value or comma-separated values), and search names with q (case-insensitive substring). ## Filtering by metadata Any query parameter prefixed metadata. is treated as a filter clause: ?metadata.env=prod\u0026amp;metadata.owner=agent-7. Multiple filters AND together — a sandbox matches only if every key/value pair is present in its metadata. Values are compared as exact strings; there is no type coercion or substring matching.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Superserve\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_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/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_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/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_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/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_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/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_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/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_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/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_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/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List all sandboxes - Superserve\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns sandboxes belonging to the authenticated team, ordered by creation time (newest first) by default. ## Pagination, sorting, and search Pass limit (and offset) to fetch one page at a time; the X-Total-Count response header reports the total across all pages. Omitting limit returns the full list, so existing unpaginated callers are unaffected. Sort with sort + order, filter by exact status (one value or comma-separated values), and search names with q (case-insensitive substring). ## Filtering by metadata Any query parameter prefixed metadata. is treated as a filter clause: ?metadata.env=prod\u0026amp;metadata.owner=agent-7. Multiple filters AND together — a sandbox matches only if every key/value pair is present in its metadata. Values are compared as exact strings; there is no type coercion or substring matching.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Superserve\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://superserve-ai-superserve-33.mintlify.site/_mintlify/api/og/v2?division=Sandboxes\u0026amp;title=List+all+sandboxes\u0026amp;description=Returns+sandboxes+belonging+to+the+authenticated+team%2C+ordered+by%0Acreation+time+%28newest+first%29+by+default.%0A%0A%23%23+Pagination%2C+sorting%2C+and+search%0A%0APass+%60limit%60+%28an\u0026amp;theme=812d3aa274a9b09d054f08f6\u0026amp;signature=5c3c5a7b08582f840bf431d72c6179e69a8174a9559e5ed39f17b004c5420789\">\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=\"List all sandboxes - Superserve\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns sandboxes belonging to the authenticated team, ordered by creation time (newest first) by default. ## Pagination, sorting, and search Pass limit (and offset) to fetch one page at a time; the X-Total-Count response header reports the total across all pages. Omitting limit returns the full list, so existing unpaginated callers are unaffected. Sort with sort + order, filter by exact status (one value or comma-separated values), and search names with q (case-insensitive substring). ## Filtering by metadata Any query parameter prefixed metadata. is treated as a filter clause: ?metadata.env=prod\u0026amp;metadata.owner=agent-7. Multiple filters AND together — a sandbox matches only if every key/value pair is present in its metadata. Values are compared as exact strings; there is no type coercion or substring matching.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://superserve-ai-superserve-33.mintlify.site/_mintlify/api/og/v2?division=Sandboxes\u0026amp;title=List+all+sandboxes\u0026amp;description=Returns+sandboxes+belonging+to+the+authenticated+team%2C+ordered+by%0Acreation+time+%28newest+first%29+by+default.%0A%0A%23%23+Pagination%2C+sorting%2C+and+search%0A%0APass+%60limit%60+%28an\u0026amp;theme=812d3aa274a9b09d054f08f6\u0026amp;signature=5c3c5a7b08582f840bf431d72c6179e69a8174a9559e5ed39f17b004c5420789\">\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/superserve-ai-superserve-33/Ce0V87RVeZcleFb4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Superserve\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#B2FAB4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sandboxes/list-all-sandboxes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.superserve.ai/#organization\",\"name\":\"Superserve\",\"url\":\"https://docs.superserve.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/superserve-ai-superserve-33/G055TX3BjwXpQedU/logo.svg?fit=max\u0026auto=format\u0026n=G055TX3BjwXpQedU\u0026q=85\u0026s=69233fb550a17b81d7d7fa083ca7f3de\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.superserve.ai#website\",\"name\":\"Superserve\",\"url\":\"https://docs.superserve.ai\",\"publisher\":{\"@id\":\"https://docs.superserve.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes#webpage\",\"url\":\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes\",\"name\":\"List all sandboxes\",\"description\":\"Returns sandboxes belonging to the authenticated team, ordered by creation time (newest first) by default. ## Pagination, sorting, and search Pass limit (and offset) to fetch one page at a time; the X-Total-Count response header reports the total across all pages. Omitting limit returns the full list, so existing unpaginated callers are unaffected. Sort with sort + order, filter by exact status (one value or comma-separated values), and search names with q (case-insensitive substring). ## Filtering by metadata Any query parameter prefixed metadata. is treated as a filter clause: ?metadata.env=prod\u0026metadata.owner=agent-7. Multiple filters AND together — a sandbox matches only if every key/value pair is present in its metadata. Values are compared as exact strings; there is no type coercion or substring matching.\",\"dateModified\":\"2026-11-06T20:32:33.983Z\",\"isPartOf\":{\"@id\":\"https://docs.superserve.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Superserve\",\"item\":\"https://docs.superserve.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List all sandboxes\",\"item\":\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes#apireference\",\"headline\":\"List all sandboxes\",\"name\":\"List all sandboxes\",\"description\":\"Returns sandboxes belonging to the authenticated team, ordered by creation time (newest first) by default. ## Pagination, sorting, and search Pass limit (and offset) to fetch one page at a time; the X-Total-Count response header reports the total across all pages. Omitting limit returns the full list, so existing unpaginated callers are unaffected. Sort with sort + order, filter by exact status (one value or comma-separated values), and search names with q (case-insensitive substring). ## Filtering by metadata Any query parameter prefixed metadata. is treated as a filter clause: ?metadata.env=prod\u0026metadata.owner=agent-7. Multiple filters AND together — a sandbox matches only if every key/value pair is present in its metadata. Values are compared as exact strings; there is no type coercion or substring matching.\",\"url\":\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.superserve.ai/api-reference/sandboxes/list-all-sandboxes#webpage\"},\"dateModified\":\"2026-11-06T20:32:33.983Z\",\"publisher\":{\"@id\":\"https://docs.superserve.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.superserve.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Superserve\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Superserve","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"SDK Reference","icon":"code","pages":[{"title":"SDK Reference","href":"/sdk-reference/sandbox"}]},{"anchor":"REST API","icon":"server","groups":[{"group":"Sandboxes","pages":[{"title":"List all sandboxes","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /sandboxes","href":"/api-reference/sandboxes/list-all-sandboxes"},{"title":"Create a new sandbox","description":"Creates a sandbox from a template (defaults to `superserve/base` when\n`from_template` is omitted), or from a saved snapshot named by\n`from_snapshot`. When the request returns successfully, the\nsandbox is ready to use — you can run commands against it\nimmediately.\n\nNew sandboxes use strict preview routing: only ports explicitly\npublished through `/sandboxes/{sandbox_id}/preview-ports` are reachable.\n`preview_access` defaults newly published ports to `public` or `private`;\neach publication may override that default independently.\n","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes","href":"/api-reference/sandboxes/create-a-new-sandbox"},{"title":"Get a sandbox by ID","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /sandboxes/{sandbox_id}","href":"/api-reference/sandboxes/get-a-sandbox-by-id"},{"title":"Partially update a running sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml patch /sandboxes/{sandbox_id}","href":"/api-reference/sandboxes/partially-update-a-running-sandbox"},{"title":"Delete a sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /sandboxes/{sandbox_id}","href":"/api-reference/sandboxes/delete-a-sandbox"},{"title":"Pause a running sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes/{sandbox_id}/pause","href":"/api-reference/sandboxes/pause-a-running-sandbox"},{"title":"Resume a paused sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes/{sandbox_id}/resume","href":"/api-reference/sandboxes/resume-a-paused-sandbox"},{"title":"Activate a sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes/{sandbox_id}/activate","href":"/api-reference/sandboxes/activate-a-sandbox"},{"title":"List a sandbox's egress activity","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /sandboxes/{sandbox_id}/network","href":"/api-reference/sandboxes/list-a-sandboxs-egress-activity"},{"title":"List published preview ports","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /sandboxes/{sandbox_id}/preview-ports","href":"/api-reference/sandboxes/list-published-preview-ports"},{"title":"Publish or update a preview port","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes/{sandbox_id}/preview-ports","href":"/api-reference/sandboxes/publish-or-update-a-preview-port"},{"title":"Unpublish a preview port","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /sandboxes/{sandbox_id}/preview-ports/{port}","href":"/api-reference/sandboxes/unpublish-a-preview-port"},{"title":"Mint a token for a private preview port","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes/{sandbox_id}/preview-ports/{port}/token","href":"/api-reference/sandboxes/mint-a-token-for-a-private-preview-port"},{"title":"Rotate a private preview port's token generation","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes/{sandbox_id}/preview-ports/{port}/token/rotate","href":"/api-reference/sandboxes/rotate-a-private-preview-ports-token-generation"}]},{"group":"Snapshots","pages":[{"title":"Snapshot a sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes/{sandbox_id}/snapshot","href":"/api-reference/snapshots/snapshot-a-sandbox"},{"title":"List a sandbox's snapshots","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /sandboxes/{sandbox_id}/snapshots","href":"/api-reference/snapshots/list-a-sandboxs-snapshots"},{"title":"Get a snapshot","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /snapshots/{snapshot_id}","href":"/api-reference/snapshots/get-a-snapshot"},{"title":"Rename a snapshot","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml patch /snapshots/{snapshot_id}","href":"/api-reference/snapshots/rename-a-snapshot"},{"title":"Delete a snapshot","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /snapshots/{snapshot_id}","href":"/api-reference/snapshots/delete-a-snapshot"}]},{"group":"Exec","pages":[{"title":"Run a command and wait for it to finish","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /exec","href":"/api-reference/exec/run-a-command-and-wait-for-it-to-finish"},{"title":"Run a command and stream output over SSE","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /exec/stream","href":"/api-reference/exec/run-a-command-and-stream-output-over-sse"},{"title":"Run a command over a WebSocket","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /exec/connect","href":"/api-reference/exec/run-a-command-over-a-websocket"}]},{"group":"Files","pages":[{"title":"List a directory inside a sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /sandboxes/{sandbox_id}/files","href":"/api-reference/files/list-a-directory-inside-a-sandbox"},{"title":"Read a file from a sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /files","href":"/api-reference/files/read-a-file-from-a-sandbox"},{"title":"Write a file to a sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /files","href":"/api-reference/files/write-a-file-to-a-sandbox"}]},{"group":"Templates","pages":[{"title":"List templates visible to the caller","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /templates","href":"/api-reference/templates/list-templates-visible-to-the-caller"},{"title":"Create a template and kick off the first build","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /templates","href":"/api-reference/templates/create-a-template-and-kick-off-the-first-build"},{"title":"Get a template by ID","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /templates/{template_id}","href":"/api-reference/templates/get-a-template-by-id"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /templates/{template_id}","href":"/api-reference/templates/delete-a-template"},{"title":"List recent builds for a template","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /templates/{template_id}/builds","href":"/api-reference/templates/list-recent-builds-for-a-template"},{"title":"Rebuild an existing template","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /templates/{template_id}/builds","href":"/api-reference/templates/rebuild-an-existing-template"},{"title":"Get a build by ID","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /templates/{template_id}/builds/{build_id}","href":"/api-reference/templates/get-a-build-by-id"},{"title":"Cancel an in-flight build","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /templates/{template_id}/builds/{build_id}","href":"/api-reference/templates/cancel-an-in-flight-build"},{"title":"Stream build logs via SSE","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /templates/{template_id}/builds/{build_id}/logs","href":"/api-reference/templates/stream-build-logs-via-sse"}]},{"group":"Secrets","pages":[{"title":"Create a secret","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /secrets","href":"/api-reference/secrets/create-a-secret"},{"title":"List secrets for the calling team","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /secrets","href":"/api-reference/secrets/list-secrets-for-the-calling-team"},{"title":"Get a secret's metadata","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /secrets/{name}","href":"/api-reference/secrets/get-a-secrets-metadata"},{"title":"Rotate a secret's value","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml patch /secrets/{name}","href":"/api-reference/secrets/rotate-a-secrets-value"},{"title":"Revoke a secret","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /secrets/{name}","href":"/api-reference/secrets/revoke-a-secret"},{"title":"Attach a secret to a sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /sandboxes/{sandbox_id}/secrets","href":"/api-reference/sandboxes/attach-a-secret-to-a-sandbox"},{"title":"Detach a secret from a sandbox","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /sandboxes/{sandbox_id}/secrets/{env_key}","href":"/api-reference/sandboxes/detach-a-secret-from-a-sandbox"},{"title":"List proxy egress events that used this credential","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /secrets/{name}/audit","href":"/api-reference/secrets/list-proxy-egress-events-that-used-this-credential"},{"title":"List sandboxes currently bound to this credential","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /secrets/{name}/sandboxes","href":"/api-reference/secrets/list-sandboxes-currently-bound-to-this-credential"},{"title":"List the built-in provider shortcut catalog","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /providers","href":"/api-reference/secrets/list-the-built-in-provider-shortcut-catalog"}]},{"group":"Team Management","pages":[{"title":"Rename a team","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml patch /teams/{team_id}","href":"/api-reference/rbac/rename-a-team"},{"title":"List team members","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /teams/{team_id}/members","href":"/api-reference/rbac/list-team-members"},{"title":"Add or invite a team member","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /teams/{team_id}/members","href":"/api-reference/rbac/add-or-invite-a-team-member"},{"title":"Deactivate a team member","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /teams/{team_id}/members/{user_id}","href":"/api-reference/rbac/deactivate-a-team-member"},{"title":"List team role assignments","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /teams/{team_id}/roles","href":"/api-reference/rbac/list-team-role-assignments"},{"title":"Assign a team role","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml post /teams/{team_id}/roles","href":"/api-reference/rbac/assign-a-team-role"},{"title":"Revoke a team role","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml delete /teams/{team_id}/roles/{assignment_id}","href":"/api-reference/rbac/revoke-a-team-role"}]},{"group":"Activity","pages":[{"title":"List team audit-log activity","deprecated":null,"version":null,"openapi":"https://api.superserve.ai/openapi.yaml get /activity","href":"/api-reference/activity/list-team-audit-log-activity"}]}]},{"anchor":"Integrations","icon":"puzzle-piece","pages":[{"title":"Integrations","href":"/integrations/overview"}]}]},"basePath":"","title":"List all sandboxes - Superserve","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BUDYNlhG.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}