{
"error": {
"code": "sandbox-closed",
"message": "sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)",
"fix": "create a new sandbox",
"requestId": "req_mh3k2f9aQ1xYz0aBcDeFgHiJ"
}
}
{
"error": {
"code": "sandbox-closed",
"message": "sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)",
"fix": "create a new sandbox",
"requestId": "req_mh3k2f9aQ1xYz0aBcDeFgHiJ"
}
}
{
"error": {
"code": "sandbox-closed",
"message": "sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)",
"fix": "create a new sandbox",
"requestId": "req_mh3k2f9aQ1xYz0aBcDeFgHiJ"
}
}
{
"error": {
"code": "sandbox-closed",
"message": "sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)",
"fix": "create a new sandbox",
"requestId": "req_mh3k2f9aQ1xYz0aBcDeFgHiJ"
}
}
Authorizations
apiKeyconsoleSession
Authorization
string
header
required
A team API key, sk_offstage_…, created in the console. Everything it touches belongs to its team.
Query Parameters
state
enum<string>
Only sandboxes in this state.
Available options:
pending,
ready,
closed
limit
integer
default:50
Page size.
Required range: 1 <= x <= 200
cursor
string
The previous page's nextCursor. It marks a position among all your items, so an item that leaves the state filter between pages never breaks the listing.
Response
A page of sandboxes.
sandboxes
object[]
required
Show child attributes
nextCursor
string | null
required
Pass as cursor for the next page; null on the last page.
{
"error": {
"code": "sandbox-closed",
"message": "sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)",
"fix": "create a new sandbox",
"requestId": "req_mh3k2f9aQ1xYz0aBcDeFgHiJ"
}
}
{
"error": {
"code": "sandbox-closed",
"message": "sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)",
"fix": "create a new sandbox",
"requestId": "req_mh3k2f9aQ1xYz0aBcDeFgHiJ"
}
}
{
"error": {
"code": "sandbox-closed",
"message": "sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)",
"fix": "create a new sandbox",
"requestId": "req_mh3k2f9aQ1xYz0aBcDeFgHiJ"
}
}
{
"error": {
"code": "sandbox-closed",
"message": "sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)",
"fix": "create a new sandbox",
"requestId": "req_mh3k2f9aQ1xYz0aBcDeFgHiJ"
}
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"offstage cloud","description":"Real Macs for AI agents and CI, over an API: sandboxes, tasks and GitHub Actions runners on Apple silicon.","colors":{"primary":"#345fe2","light":"#8aa5ff","dark":"#234cce"},"logo":{"light":"https://mintcdn.com/exla-e9c279d7/eaKyCmNY9fQiOBbi/logo/light.svg?fit=max\u0026auto=format\u0026n=eaKyCmNY9fQiOBbi\u0026q=85\u0026s=d973dc9e7a653dc2368ad574f71c6294","dark":"https://mintcdn.com/exla-e9c279d7/eaKyCmNY9fQiOBbi/logo/dark.svg?fit=max\u0026auto=format\u0026n=eaKyCmNY9fQiOBbi\u0026q=85\u0026s=d55abf8fefbeaac3c7e05dabf58eec85","href":"https://offstage.cloud"},"favicon":"https://mintcdn.com/exla-e9c279d7/eaKyCmNY9fQiOBbi/favicon.svg?fit=max\u0026auto=format\u0026n=eaKyCmNY9fQiOBbi\u0026q=85\u0026s=62e1f38b24e71715f6de34bcc3396a41","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"navbar":{"links":[{"href":"https://offstage.cloud/#pricing","label":"Pricing"},{"href":"https://console.offstage.cloud","label":"Console"}],"primary":{"type":"button","label":"Try it free","href":"https://console.offstage.cloud/sign-up"}},"footer":{"links":[{"header":"offstage cloud","items":[{"label":"Home","href":"https://offstage.cloud"},{"label":"Console","href":"https://console.offstage.cloud"},{"label":"Talk to an engineer","href":"https://offstage.cloud/join?talk=1"}]},{"header":"For agents","items":[{"label":"SKILL.md","href":"https://api.offstage.cloud/SKILL.md"},{"label":"llms.txt","href":"https://api.offstage.cloud/llms.txt"},{"label":"OpenAPI","href":"https://api.offstage.cloud/openapi.json"}]},{"header":"Legal","items":[{"label":"Privacy","href":"https://offstage.cloud/privacy"},{"label":"Terms","href":"https://offstage.cloud/terms"}]}]},"search":{"prompt":"Search the docs"},"seo":{"metatags":{"canonical":"https://offstage.cloud/docs"}},"fonts":{"family":"Mona Sans"},"icons":{"library":"lucide"},"integrations":{"ga4":{"measurementId":"G-N495S8F58S"},"posthog":{"apiKey":"phc_pCLbtJkE8FKNNt9AjeuW67gQHyisLsJZFi42JJ9ckZUg","apiHost":"https://offstage.cloud/ph"}},"errors":{"404":{"redirect":false,"title":"This page isn't here","description":"Try the search, or start from the [introduction](/)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor","vscode","mcp"],"display":"header"},"markdown":{"instructions":"To set up offstage cloud from a coding agent, read https://api.offstage.cloud/SKILL.md and follow it. The whole API guide is one file at https://api.offstage.cloud/llms.txt."},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"exla-e9c279d7","hasAudioNarration":false,"actualSubdomain":"exla-e9c279d7","customDomains":["offstage.cloud"],"gitSource":{"type":"github","owner":"exla-ai","repo":"offstage","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":"","_id":"6afe612edcaa49e19dc49297"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b02de76173fddf89faa59e2","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Endpoints","count":71},{"language":"default","tag":"Account","count":22},{"language":"default","tag":"Sandboxes","count":19},{"language":"default","tag":"API reference","count":18},{"language":"default","tag":"Billing","count":13},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Basics","count":7},{"language":"default","tag":"Account and billing","count":6},{"language":"default","tag":"Run on a Mac","count":6},{"language":"default","tag":"Tasks","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"site-roles","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":"editor-metadata","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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* latin-ext */\n@font-face {\n font-family: 'Instrument Serif';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/instrumentserif/v5/jizBRFtNs2ka5fXjeivQ4LroWlx-6zsTjmbI.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Instrument Serif';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/instrumentserif/v5/jizBRFtNs2ka5fXjeivQ4LroWlx-6zUTjg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n#page-title,#content>h2{font-family:\"Instrument Serif\", Georgia, serif;font-weight:400;letter-spacing:-0.015em}#page-title{font-size:2.75rem;line-height:1.08}#content>h2{font-size:2rem;line-height:1.15}[data-layout-item=\"assistant-entry\"],#chat-assistant-sheet,.chat-assistant-floating-input,#ask-assistant-code-block-button,[data-search-item=\"header-button\"],[data-search-item=\"group\"][data-variant=\"ask-ai\"],[data-search-item=\"item\"][data-variant=\"assistant\"]{display:none!important}#content-area:has(#snapshot-guide-navigation)>#pagination{display:none}"}]}
{"page":{"pagePath":"api-reference/sandboxes/list-sandboxes","slug":"/api-reference/sandboxes/list-sandboxes","pageMetadata":{"title":"List sandboxes","description":"Lists the team's sandboxes, newest first. Filter by `state`; page with `limit` and `cursor`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sandboxes","href":"/api-reference/sandboxes/list-sandboxes","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Lists the team’s sandboxes, newest first. Filter by \", _jsx(_components.code, {\n children: \"state\"\n }), \"; page with \", _jsx(_components.code, {\n children: \"limit\"\n }), \" and \", _jsx(_components.code, {\n children: \"cursor\"\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":{"config":{},"pageMetadata":{"title":"List sandboxes","description":"Lists the team's sandboxes, newest first. Filter by `state`; page with `limit` and `cursor`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sandboxes","href":"/api-reference/sandboxes/list-sandboxes","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listSandboxes","tags":["Sandboxes"],"summary":"List sandboxes","description":"Lists the team's sandboxes, newest first. Filter by `state`; page with `limit` and `cursor`.","security":["3e5ec8e4-783d-4134-91ce-338526080aa7","17f398e5-bdd8-4ef0-bf9a-4e6bdd606b6b"],"parameters":["6f26f1dc-313d-4539-8405-e9a572f6fd9a","2e9ee9d0-08e0-4c2c-bc16-d7e8e44ded49","bd949952-5275-45f6-b10d-08e1bbd0214f"],"responses":{"200":"ffc44571-d3f6-45f3-82bc-121a9c248c90","400":"3a6365cb-e2cb-43cf-b932-f6cf8c0035e3","401":"aa91d688-ae41-43e2-aa20-a31840b161ad","413":"3316f377-bc67-4132-b545-4504892c3d7b","429":"5d596e25-d02b-43de-82d9-5b6dd78ea2a9"},"method":"get","type":"path","servers":["2782005c-e346-4532-a339-b05adcf78d23"],"path":"/v1/sandboxes","baseUrlOptions":["https://api.offstage.cloud"],"title":"List sandboxes","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6f26f1dc-313d-4539-8405-e9a572f6fd9a":{"name":"state","in":"query","required":false,"description":"Only sandboxes in this state.","schema":{"type":"string","enum":["pending","ready","closed"],"isRequired":false,"description":"Only sandboxes in this state.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"2e9ee9d0-08e0-4c2c-bc16-d7e8e44ded49":{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"isRequired":false,"description":"Page size.","uniqueKey":"","typeLabel":"integer"}},"bd949952-5275-45f6-b10d-08e1bbd0214f":{"name":"cursor","in":"query","required":false,"description":"The previous page's `nextCursor`. It marks a position among all your items, so an item that leaves the `state` filter between pages never breaks the listing.","schema":{"type":"string","isRequired":false,"description":"The previous page's `nextCursor`. It marks a position among all your items, so an item that leaves the `state` filter between pages never breaks the listing.","uniqueKey":"","typeLabel":"string"}}},"responses":{"ffc44571-d3f6-45f3-82bc-121a9c248c90":{"description":"A page of sandboxes.","headers":{"x-request-id":{"description":"This request's id, `req_…`. Quote it when asking for help.","required":true,"schema":{"type":"string","pattern":"^req_"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sandboxes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`sbx_…`.","pattern":"^sbx_","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":48,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$","description":"What people call it, like `swift-otter`: picked at creation unless you choose one, and unique among the team's open sandboxes. Routes take the `id`, not the name.","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].name","typeLabel":"string"},"session":{"type":"string","enum":["headless","gui"],"description":"`headless`: the slot's user with no desktop; every slot takes it from boot. `gui`: the slot's logged-in desktop session, remade after every customer, so `gui` slots are scarce.","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].session","typeLabel":"enum\u003cstring>"},"state":{"type":"string","enum":["pending","ready","closed"],"description":"`pending` until a slot takes it, `ready` while it is held, then `closed`.","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"integer","minimum":0,"description":"A time, in Unix milliseconds.","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].createdAt","typeLabel":"integer"},"expiresAt":{"type":"integer","minimum":0,"description":"Current deadline in Unix milliseconds. For a restore, the sandbox lifetime starts when setup succeeds.","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].expiresAt","typeLabel":"integer"},"timeoutMs":{"type":"integer","description":"Sandbox lifetime, counted from creation or, for a restore, from readiness.","minimum":1,"isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].timeoutMs","typeLabel":"integer"},"idleTimeoutMs":{"type":"integer","description":"It closes after this long with no op.","minimum":1,"isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].idleTimeoutMs","typeLabel":"integer"},"lastActivityAt":{"type":"integer","minimum":0,"description":"A time, in Unix milliseconds.","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].lastActivityAt","typeLabel":"integer"},"ops":{"type":"integer","description":"Commands, file calls and screenshots run in it so far. The pictures the plane takes for its recording are not counted.","minimum":0,"isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].ops","typeLabel":"integer"},"costUsd":{"type":"number","description":"What its time on a Mac costs: so far while open, final once closed.","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].costUsd","typeLabel":"number"},"createdBy":{"oneOf":[{"type":"object","description":"Who started the work: `{keyName}` for an API key, `{email}` for a console user.","required":["keyName"],"properties":{"keyName":{"type":"string","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].createdBy.oneOf.0.keyName","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].createdBy.oneOf.0","typeLabel":"object"},{"type":"object","description":"Who started the work: `{keyName}` for an API key, `{email}` for a console user.","required":["email"],"properties":{"email":{"type":"string","isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].createdBy.oneOf.1.email","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].createdBy.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"sandboxes.items.[INDEX].createdBy","typeLabel":"object"},"snapshotId":{"type":"string","description":"The source snapshot ID when restored.","uniqueKey":"sandboxes.items.[INDEX].snapshotId","typeLabel":"string"},"boxId":{"type":"string","description":"The Mac holding it. Absent until a slot takes it.","pattern":"^box_","uniqueKey":"sandboxes.items.[INDEX].boxId","typeLabel":"string"},"slot":{"type":"integer","description":"The slot on that Mac. Absent until taken.","minimum":1,"uniqueKey":"sandboxes.items.[INDEX].slot","typeLabel":"integer"},"readyAt":{"type":"integer","minimum":0,"description":"When it became `ready`; billing starts here. Absent until then.","uniqueKey":"sandboxes.items.[INDEX].readyAt","typeLabel":"integer"},"closedAt":{"type":"integer","minimum":0,"description":"Absent until it closes.","uniqueKey":"sandboxes.items.[INDEX].closedAt","typeLabel":"integer"},"closeReason":{"type":"string","enum":["deleted","expired","idle","box-lost","plane-restart","no-capacity","restore-failed","secret-unavailable"],"description":"Absent until it closes.","uniqueKey":"sandboxes.items.[INDEX].closeReason","typeLabel":"enum\u003cstring>"},"runtimeSeconds":{"type":"integer","description":"Whole seconds from `ready` to closed (or now). Absent until ready.","minimum":0,"uniqueKey":"sandboxes.items.[INDEX].runtimeSeconds","typeLabel":"integer"},"record":{"type":"boolean","description":"Whether the plane keeps a recording of it: true for a `gui` sandbox unless created with `record: false`.","uniqueKey":"sandboxes.items.[INDEX].record","typeLabel":"boolean"},"replayUrl":{"type":"string","description":"Where to watch it, live while it is open and as a replay after: the console's `/r/{id}` page. Present when it records.","uniqueKey":"sandboxes.items.[INDEX].replayUrl","typeLabel":"string"}},"required":["id","name","session","state","createdAt","expiresAt","timeoutMs","idleTimeoutMs","lastActivityAt","ops","costUsd","createdBy"],"additionalProperties":false,"description":"A sandbox: one Mac slot (a macOS user account) held for the team. Files persist between calls. Fields that do not apply yet are absent, not null.","examples":[{"id":"sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ","name":"swift-otter","session":"headless","state":"ready","createdAt":1793000000000,"expiresAt":1793001800000,"timeoutMs":1800000,"idleTimeoutMs":600000,"lastActivityAt":1793000040000,"boxId":"box_mh3k2f9aQ1xYz0aBcDeFgHiJ","slot":3,"readyAt":1793000000100,"ops":12,"runtimeSeconds":40,"costUsd":0.002733,"createdBy":{"keyName":"ci"}}],"uniqueKey":"sandboxes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"sandboxes","typeLabel":"object[]"},"nextCursor":{"oneOf":[{"type":"string","description":"Pass as `cursor` for the next page; null on the last page.","isRequired":true,"uniqueKey":"nextCursor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pass as `cursor` for the next page; null on the last page.","isRequired":true,"uniqueKey":"nextCursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nextCursor","typeLabel":"string | null"}},"required":["sandboxes","nextCursor"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"sandboxes":[{"id":"sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ","name":"swift-otter","session":"headless","state":"ready","createdAt":1793000000000,"expiresAt":1793001800000,"timeoutMs":1800000,"idleTimeoutMs":600000,"lastActivityAt":1793000040000,"boxId":"box_mh3k2f9aQ1xYz0aBcDeFgHiJ","slot":3,"readyAt":1793000000100,"ops":12,"runtimeSeconds":40,"costUsd":0.002733,"createdBy":{"keyName":"ci"}}],"nextCursor":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3a6365cb-e2cb-43cf-b932-f6cf8c0035e3":{"description":"`bad-state`, `bad-limit`, or `bad-cursor`.","headers":{"x-request-id":{"description":"This request's id, `req_…`. Quote it when asking for help.","required":true,"schema":{"type":"string","pattern":"^req_"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable, like `sandbox-closed`. Switch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"The same as the `x-request-id` header. Quote it when asking for help.","pattern":"^req_","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"fix":{"type":"string","description":"What to do about it, when there is something to do.","uniqueKey":"error.fix","typeLabel":"string"}},"required":["code","message","requestId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The one error envelope: every 4xx and 5xx the plane itself sends. A proxy in front of it may send a 5xx whose body is not JSON.","examples":[{"error":{"code":"sandbox-closed","message":"sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)","fix":"create a new sandbox","requestId":"req_mh3k2f9aQ1xYz0aBcDeFgHiJ"}}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"sandbox-closed","message":"sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)","fix":"create a new sandbox","requestId":"req_mh3k2f9aQ1xYz0aBcDeFgHiJ"}}}},"exampleType":"generated"}},"exampleType":"generated"},"aa91d688-ae41-43e2-aa20-a31840b161ad":{"description":"`unauthorized`: no credential, an `Authorization` header that is not `Bearer …`, a value that is not an `sk_offstage_` (or older `oc_live_`) key, a revoked or unknown key, or a box token. The message says which.","headers":{"x-request-id":{"description":"This request's id, `req_…`. Quote it when asking for help.","required":true,"schema":{"type":"string","pattern":"^req_"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable, like `sandbox-closed`. Switch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"The same as the `x-request-id` header. Quote it when asking for help.","pattern":"^req_","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"fix":{"type":"string","description":"What to do about it, when there is something to do.","uniqueKey":"error.fix","typeLabel":"string"}},"required":["code","message","requestId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The one error envelope: every 4xx and 5xx the plane itself sends. A proxy in front of it may send a 5xx whose body is not JSON.","examples":[{"error":{"code":"sandbox-closed","message":"sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)","fix":"create a new sandbox","requestId":"req_mh3k2f9aQ1xYz0aBcDeFgHiJ"}}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"sandbox-closed","message":"sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)","fix":"create a new sandbox","requestId":"req_mh3k2f9aQ1xYz0aBcDeFgHiJ"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3316f377-bc67-4132-b545-4504892c3d7b":{"description":"The JSON body is over 1 MiB (a `command` is 64 KiB at most; the rest is spare).","headers":{"x-request-id":{"description":"This request's id, `req_…`. Quote it when asking for help.","required":true,"schema":{"type":"string","pattern":"^req_"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable, like `sandbox-closed`. Switch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"The same as the `x-request-id` header. Quote it when asking for help.","pattern":"^req_","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"fix":{"type":"string","description":"What to do about it, when there is something to do.","uniqueKey":"error.fix","typeLabel":"string"}},"required":["code","message","requestId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The one error envelope: every 4xx and 5xx the plane itself sends. A proxy in front of it may send a 5xx whose body is not JSON.","examples":[{"error":{"code":"sandbox-closed","message":"sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)","fix":"create a new sandbox","requestId":"req_mh3k2f9aQ1xYz0aBcDeFgHiJ"}}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"sandbox-closed","message":"sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)","fix":"create a new sandbox","requestId":"req_mh3k2f9aQ1xYz0aBcDeFgHiJ"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5d596e25-d02b-43de-82d9-5b6dd78ea2a9":{"description":"`rate-limit`: this team has sent more than 120 requests in the last 60 s, or this client address more than 600 (fewer on the routes that need no credential). The `Retry-After` header gives the seconds left in the window.","headers":{"x-request-id":{"description":"This request's id, `req_…`. Quote it when asking for help.","required":true,"schema":{"type":"string","pattern":"^req_"}},"Retry-After":{"schema":{"type":"string"},"description":"Seconds until the window opens again."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable, like `sandbox-closed`. Switch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"The same as the `x-request-id` header. Quote it when asking for help.","pattern":"^req_","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"fix":{"type":"string","description":"What to do about it, when there is something to do.","uniqueKey":"error.fix","typeLabel":"string"}},"required":["code","message","requestId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The one error envelope: every 4xx and 5xx the plane itself sends. A proxy in front of it may send a 5xx whose body is not JSON.","examples":[{"error":{"code":"sandbox-closed","message":"sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)","fix":"create a new sandbox","requestId":"req_mh3k2f9aQ1xYz0aBcDeFgHiJ"}}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"sandbox-closed","message":"sandbox sbx_mh3k2f9aQ1xYz0aBcDeFgHiJ is closed (idle)","fix":"create a new sandbox","requestId":"req_mh3k2f9aQ1xYz0aBcDeFgHiJ"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3e5ec8e4-783d-4134-91ce-338526080aa7":{"apiKey":{"type":"http","scheme":"bearer","description":"A team API key, `sk_offstage_…`, created in the console. Everything it touches belongs to its team.","scopes":[],"schemeName":"apiKey"}},"17f398e5-bdd8-4ef0-bf9a-4e6bdd606b6b":{"consoleSession":{"type":"apiKey","in":"cookie","name":"oc_session","description":"The console's session cookie (httpOnly, SameSite=Lax, 30 days), set by `signup` and `login`.","scopes":[],"schemeName":"consoleSession"}}},"servers":{"2782005c-e346-4532-a339-b05adcf78d23":{"url":"https://api.offstage.cloud"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A team API key, `sk_offstage_…`, created in the console. Everything it touches belongs to its team.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A team API key, `sk_offstage_…`, created in the console. Everything it touches belongs to its team.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"},{"schemes":[{"scheme":{"type":"apiKey","in":"cookie","name":"oc_session","description":"The console's session cookie (httpOnly, SameSite=Lax, 30 days), set by `signup` and `login`.","scopes":[],"schemeName":"consoleSession"},"schema":{"title":"oc_session","type":"string","description":"The console's session cookie (httpOnly, SameSite=Lax, 30 days), set by `signup` and `login`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"consoleSession","name":"oc_session"}],"title":"consoleSession"}]},"originalFileLocation":"openapi.json"},"subdomain":"exla-e9c279d7","siteName":"offstage cloud","title":"List sandboxes - offstage cloud","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-22T12:00:53.136Z","originalFileLocation":"api-reference/sandboxes/list-sandboxes.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Lists the team\u0026#x27;s sandboxes, newest first. Filter by state; page with limit and cursor.\">\u003cmeta data-mint-head name=\"application-name\" content=\"offstage cloud\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_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=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List sandboxes - offstage cloud\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists the team\u0026#x27;s sandboxes, newest first. Filter by state; page with limit and cursor.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"offstage cloud\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://exla-e9c279d7.mintlify.site/docs/_mintlify/api/og/v2?division=Sandboxes\u0026amp;title=List+sandboxes\u0026amp;description=Lists+the+team%27s+sandboxes%2C+newest+first.+Filter+by+%60state%60%3B+page+with+%60limit%60+and+%60cursor%60.\u0026amp;theme=6689bbe7c2e94389d801fa51\u0026amp;signature=288be257a82854ea9b7238c1cad19f4d50f2e602cb617b888d37dc187d96f1c1\">\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 sandboxes - offstage cloud\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists the team\u0026#x27;s sandboxes, newest first. Filter by state; page with limit and cursor.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://exla-e9c279d7.mintlify.site/docs/_mintlify/api/og/v2?division=Sandboxes\u0026amp;title=List+sandboxes\u0026amp;description=Lists+the+team%27s+sandboxes%2C+newest+first.+Filter+by+%60state%60%3B+page+with+%60limit%60+and+%60cursor%60.\u0026amp;theme=6689bbe7c2e94389d801fa51\u0026amp;signature=288be257a82854ea9b7238c1cad19f4d50f2e602cb617b888d37dc187d96f1c1\">\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=\"/docs/mintlify-assets/_mintlify/favicons/exla-e9c279d7/_AtwJuXttT4MUWZb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"offstage cloud\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#345fe2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/sandboxes/list-sandboxes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://offstage.cloud/#organization\",\"name\":\"offstage cloud\",\"url\":\"https://offstage.cloud\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/exla-e9c279d7/eaKyCmNY9fQiOBbi/logo/light.svg?fit=max\u0026auto=format\u0026n=eaKyCmNY9fQiOBbi\u0026q=85\u0026s=d973dc9e7a653dc2368ad574f71c6294\"}},{\"@type\":\"WebSite\",\"@id\":\"https://offstage.cloud/docs#website\",\"name\":\"offstage cloud\",\"url\":\"https://offstage.cloud/docs\",\"publisher\":{\"@id\":\"https://offstage.cloud/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes#webpage\",\"url\":\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes\",\"name\":\"List sandboxes\",\"description\":\"Lists the team's sandboxes, newest first. Filter by state; page with limit and cursor.\",\"dateModified\":\"2026-11-22T12:00:53.136Z\",\"isPartOf\":{\"@id\":\"https://offstage.cloud/docs#website\"},\"breadcrumb\":{\"@id\":\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"offstage cloud\",\"item\":\"https://offstage.cloud/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List sandboxes\",\"item\":\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes#apireference\",\"headline\":\"List sandboxes\",\"name\":\"List sandboxes\",\"description\":\"Lists the team's sandboxes, newest first. Filter by state; page with limit and cursor.\",\"url\":\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes\",\"mainEntityOfPage\":{\"@id\":\"https://offstage.cloud/docs/api-reference/sandboxes/list-sandboxes#webpage\"},\"dateModified\":\"2026-11-22T12:00:53.136Z\",\"publisher\":{\"@id\":\"https://offstage.cloud/#organization\"},\"isPartOf\":{\"@id\":\"https://offstage.cloud/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"offstage cloud\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"offstage cloud\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/sandboxes/list-sandboxes.md","siteName":"offstage cloud","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/api"}]},{"tab":"Endpoints","groups":[{"group":"Sandboxes","pages":[{"title":"List sandboxes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sandboxes","href":"/api-reference/sandboxes/list-sandboxes"},{"title":"Create a sandbox","description":"Creates a sandbox: one macOS user account on a fleet Mac, held for you until it closes. It is `pending` until a slot takes it and then `ready`, and bills per second from `ready` until it closes. An empty body gives a default headless sandbox; its worst case (`timeoutMs` at the hourly price) is reserved against the credit and the budget.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sandboxes","href":"/api-reference/sandboxes/create-a-sandbox"},{"title":"Save a sandbox snapshot","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sandboxes/{sandboxId}/snapshots","href":"/api-reference/sandboxes/save-a-sandbox-snapshot"},{"title":"List snapshots","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/snapshots","href":"/api-reference/sandboxes/list-snapshots"},{"title":"Read a snapshot","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/snapshots/{snapshotId}","href":"/api-reference/sandboxes/read-a-snapshot"},{"title":"Delete a snapshot","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/snapshots/{snapshotId}","href":"/api-reference/sandboxes/delete-a-snapshot"},{"title":"Get a sandbox","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sandboxes/{sandboxId}","href":"/api-reference/sandboxes/get-a-sandbox"},{"title":"Kill a sandbox","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/sandboxes/{sandboxId}","href":"/api-reference/sandboxes/kill-a-sandbox"},{"title":"Rename a sandbox","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/sandboxes/{sandboxId}","href":"/api-reference/sandboxes/rename-a-sandbox"},{"title":"Set the timeout","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sandboxes/{sandboxId}/timeout","href":"/api-reference/sandboxes/set-the-timeout"},{"title":"Run a command","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sandboxes/{sandboxId}/commands","href":"/api-reference/sandboxes/run-a-command"},{"title":"Follow a command","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sandboxes/{sandboxId}/commands/{commandId}","href":"/api-reference/sandboxes/follow-a-command"},{"title":"Read a file","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sandboxes/{sandboxId}/files","href":"/api-reference/sandboxes/read-a-file"},{"title":"Write a file","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/sandboxes/{sandboxId}/files","href":"/api-reference/sandboxes/write-a-file"},{"title":"Take a screenshot","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sandboxes/{sandboxId}/screenshot","href":"/api-reference/sandboxes/take-a-screenshot"},{"title":"Click, type and press keys","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sandboxes/{sandboxId}/input","href":"/api-reference/sandboxes/click-type-and-press-keys"},{"title":"Hand the screen a goal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sandboxes/{sandboxId}/agent","href":"/api-reference/sandboxes/hand-the-screen-a-goal"},{"title":"Follow a run","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{runId}","href":"/api-reference/sandboxes/follow-a-run"},{"title":"Get a run's screenshot","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/runs/{runId}/frames/{frame}","href":"/api-reference/sandboxes/get-a-runs-screenshot"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Submit a task","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tasks","href":"/api-reference/tasks/submit-a-task"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tasks/{taskId}","href":"/api-reference/tasks/get-a-task"},{"title":"Cancel a task","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tasks/{taskId}/cancel","href":"/api-reference/tasks/cancel-a-task"},{"title":"Download an artifact","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tasks/{taskId}/artifacts/{name}","href":"/api-reference/tasks/download-an-artifact"}]},{"group":"Recordings","pages":[{"title":"Get a recording","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/recordings/{recordingId}","href":"/api-reference/recordings/get-a-recording"},{"title":"Get a recording's picture","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/recordings/{recordingId}/frames/{frame}","href":"/api-reference/recordings/get-a-recordings-picture"},{"title":"Follow a recording live","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/recordings/{recordingId}/live","href":"/api-reference/recordings/follow-a-recording-live"}]},{"group":"Capacity","pages":[{"title":"Fleet capacity","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/capacity","href":"/api-reference/capacity/fleet-capacity"},{"title":"Health","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/health","href":"/api-reference/capacity/health"}]},{"group":"Billing","pages":[{"title":"The price sheet","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/pricing","href":"/api-reference/billing/the-price-sheet"},{"title":"Usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/billing/usage"},{"title":"Billing state","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing","href":"/api-reference/billing/billing-state"},{"title":"Set the budget","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/billing/budget","href":"/api-reference/billing/set-the-budget"},{"title":"Start adding a card","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/billing/checkout","href":"/api-reference/billing/start-adding-a-card"},{"title":"Finish adding a card","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/billing/checkout/complete","href":"/api-reference/billing/finish-adding-a-card"},{"title":"Start buying credit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/billing/credit/checkout","href":"/api-reference/billing/start-buying-credit"},{"title":"Finish buying credit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/billing/credit/complete","href":"/api-reference/billing/finish-buying-credit"},{"title":"Turn auto-reload on or off","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/billing/auto-reload","href":"/api-reference/billing/turn-auto-reload-on-or-off"},{"title":"List credit bought","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing/purchases","href":"/api-reference/billing/list-credit-bought"},{"title":"Remove the card","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/billing/card","href":"/api-reference/billing/remove-the-card"},{"title":"Open the customer portal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/billing/portal","href":"/api-reference/billing/open-the-customer-portal"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing/invoices","href":"/api-reference/billing/list-invoices"}]},{"group":"Account","pages":[{"title":"Sign up","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/signup","href":"/api-reference/account/sign-up"},{"title":"Sign in","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/login","href":"/api-reference/account/sign-in"},{"title":"What the sign-in page offers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/auth/config","href":"/api-reference/account/what-the-sign-in-page-offers"},{"title":"Sign in with GitHub or Google","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/clerk","href":"/api-reference/account/sign-in-with-github-or-google"},{"title":"Sign out","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/logout","href":"/api-reference/account/sign-out"},{"title":"Verify an email","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/verify","href":"/api-reference/account/verify-an-email"},{"title":"Send the verification email again","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/resend-verification","href":"/api-reference/account/send-the-verification-email-again"},{"title":"Ask for a password-reset link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/forgot-password","href":"/api-reference/account/ask-for-a-password-reset-link"},{"title":"Choose a new password","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auth/reset-password","href":"/api-reference/account/choose-a-new-password"},{"title":"The signed-in user","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me","href":"/api-reference/account/the-signed-in-user"},{"title":"Switch teams","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/me/team","href":"/api-reference/account/switch-teams"},{"title":"The team","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/team","href":"/api-reference/account/the-team"},{"title":"Rename the team","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/team","href":"/api-reference/account/rename-the-team"},{"title":"List members","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/team/members","href":"/api-reference/account/list-members"},{"title":"Invite a member","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/team/members","href":"/api-reference/account/invite-a-member"},{"title":"Remove a member","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/team/members/{userId}","href":"/api-reference/account/remove-a-member"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/team/members/{userId}","href":"/api-reference/account/change-a-members-role"},{"title":"Withdraw an invite","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/team/invites/{email}","href":"/api-reference/account/withdraw-an-invite"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/keys","href":"/api-reference/account/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/keys","href":"/api-reference/account/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/keys/{keyId}","href":"/api-reference/account/revoke-an-api-key"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/teams","href":"/api-reference/account/create-an-organization"}]},{"group":"GitHub","pages":[{"title":"The team's GitHub connection","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/github","href":"/api-reference/github/the-teams-github-connection"},{"title":"Start connecting a GitHub organization","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/github/install","href":"/api-reference/github/start-connecting-a-github-organization"},{"title":"Disconnect a GitHub installation","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/github/installations/{installationId}","href":"/api-reference/github/disconnect-a-github-installation"},{"title":"Read this team’s GitHub connection and repository access","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/github/installations","href":"/api-reference/github/read-this-team’s-github-connection-and-repository-access"}]},{"group":"Secrets","pages":[{"title":"List team secret metadata","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/secrets","href":"/api-reference/secrets/list-team-secret-metadata"},{"title":"Create or replace a write-only team secret","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/secrets/{name}","href":"/api-reference/secrets/create-or-replace-a-write-only-team-secret"},{"title":"Delete a team secret","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/secrets/{name}","href":"/api-reference/secrets/delete-a-team-secret"}]}]}]},"basePath":"","title":"List sandboxes - offstage cloud","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","b0f84f53ff","2b790eda92","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","Page--B9YZ09u.js","CodeSnippet-CTZvgJfu.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","getApiPlaygroundDisplay-BK2o1XYu.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}