Your storage use, limits, this month's cost and credit balance.
Your personal org’s sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace’s API key, that workspace’s; with org, that org’s. org in the answer names the org it describes. cost is the org’s cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as usage on GET /v1/orgs/{id}). Stored data is as of computedAt, usually under an hour old. API keys: needs one of the scopes machines:read, images:read.
GET
/
v1
/
usage
Your storage use, limits, this month's cost and credit balance.
An org you belong to (org_...), personal or workspace, to report instead of the default. A workspace API key may name only its own workspace. An org you are not a member of, or that does not exist, answers 404 not_found, as GET /v1/orgs/{id} does.
When the byte figures were last computed or confirmed. A usage run every 10 minutes confirms unchanged orgs and recomputes changed ones (each at most every 30 minutes), so usually under an hour old. An org that stores nothing reads 0 as of now; null only while stored data waits for its first run.
What they take up once compressed, with shared data counted once and the templates' own content (an unchanged root filesystem) not counted: what you wrote on the root filesystem counts. Paused sandboxes' saved memory does not count.
This calendar month's (UTC) cost in USD as the hourly rating priced it (costUSD, with runtimeUSD, storageUSD and egressUSD), up to ratedUntil; the allowance (allowanceUSD, creditRemainingUSD, overageUSD) and the credit balance (creditsUSD, creditsExpireAt). The same figures as usage on GET /v1/orgs/{id}. A free sandbox is never billed, so a free month is 0. Absent from older servers.
The org these figures and limits describe: your personal org by default, a workspace key's workspace, or the one named with org. Absent from older servers.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"InstaBox","description":"A Linux machine of its own in the cloud for every agent.","colors":{"primary":"#0A0A0A","light":"#FAFAFA","dark":"#0A0A0A"},"logo":{"light":"https://instacloud.mintlify.site/docs/logo/light.svg","dark":"https://instacloud.mintlify.site/docs/logo/dark.svg","href":"https://instabox.sh"},"favicon":"https://mintlify.s3.us-west-1.amazonaws.com/instacloud/instabox/favicon.svg","appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://instabox.sh/pricing","label":"Pricing"},{"href":"https://instabox.sh/changelog","label":"Changelog"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.instabox.sh"}},"footer":{"socials":{"github":"https://github.com/InsForge"}},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode","mcp"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"instacloud","hasAudioNarration":false,"actualSubdomain":"instacloud","customDomains":["instabox.sh"],"gitSource":{"type":"github","owner":"insforge","repo":"instabox","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"instabox","label":"","_id":"6aed4ce60814409ea4a899b5"},"feedback":{"thumbs":true,"contextualFeedback":{"allowEmail":false}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af24f2490cec7c60d18d067","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API reference","count":86},{"language":"default","tag":"Documentation","count":34},{"language":"default","tag":"Machines","count":15},{"language":"default","tag":"Use cases","count":9},{"language":"default","tag":"SDK reference","count":8},{"language":"default","tag":"Lifecycle","count":8},{"language":"default","tag":"Secrets","count":7},{"language":"default","tag":"Account","count":6},{"language":"default","tag":"TypeScript","count":6},{"language":"default","tag":"Get started","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":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance","slug":"/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance","pageMetadata":{"title":"Your storage use, limits, this month's cost and credit balance.","description":"Your personal org's sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace's API key, that workspace's; with `org`, that org's. `org` in the answer names the org it describes. `cost` is the org's cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as `usage` on `GET /v1/orgs/{id}`). Stored data is as of `computedAt`, usually under an hour old. API keys: needs one of the scopes `machines:read`, `images:read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/usage","href":"/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance","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: [\"Your personal org’s sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace’s API key, that workspace’s; with \", _jsx(_components.code, {\n children: \"org\"\n }), \", that org’s. \", _jsx(_components.code, {\n children: \"org\"\n }), \" in the answer names the org it describes. \", _jsx(_components.code, {\n children: \"cost\"\n }), \" is the org’s cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as \", _jsx(_components.code, {\n children: \"usage\"\n }), \" on \", _jsx(_components.code, {\n children: \"GET /v1/orgs/{id}\"\n }), \"). Stored data is as of \", _jsx(_components.code, {\n children: \"computedAt\"\n }), \", usually under an hour old. API keys: needs one of the scopes \", _jsx(_components.code, {\n children: \"machines:read\"\n }), \", \", _jsx(_components.code, {\n children: \"images:read\"\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":"Your storage use, limits, this month's cost and credit balance.","description":"Your personal org's sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace's API key, that workspace's; with `org`, that org's. `org` in the answer names the org it describes. `cost` is the org's cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as `usage` on `GET /v1/orgs/{id}`). Stored data is as of `computedAt`, usually under an hour old. API keys: needs one of the scopes `machines:read`, `images:read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/usage","href":"/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["usage"],"operationId":"getUsage","summary":"Your storage use, limits, this month's cost and credit balance.","security":["b38b9c01-422f-4cb8-a804-a9defdea6f7f","3ee83008-a74d-4e34-ab14-2ffb2028f8e9","f47084a2-cd12-4366-9dd2-cf274879cefa"],"description":"Your personal org's sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace's API key, that workspace's; with `org`, that org's. `org` in the answer names the org it describes. `cost` is the org's cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as `usage` on `GET /v1/orgs/{id}`). Stored data is as of `computedAt`, usually under an hour old. API keys: needs one of the scopes `machines:read`, `images:read`.","parameters":["6739a016-2ca1-4461-ab76-a3fa83de2491"],"responses":{"200":"962bea41-c4fb-4d22-9c14-400affcc01c6","401":"876fbe05-fb9a-428f-8674-3f7033211780","404":"9ffc0d99-ca84-460b-baa5-517f7397830a"},"method":"get","type":"path","servers":["e2c665bb-4b53-46fa-8dd3-3dba6e3ac4a8"],"path":"/v1/usage","baseUrlOptions":["https://api.instabox.sh"],"title":"Your storage use, limits, this month's cost and credit balance.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6739a016-2ca1-4461-ab76-a3fa83de2491":{"name":"org","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"An org you belong to (org_...), personal or workspace, to report instead of the default. A workspace API key may name only its own workspace. An org you are not a member of, or that does not exist, answers `404 not_found`, as `GET /v1/orgs/{id}` does.","uniqueKey":"","typeLabel":"string"},"description":"An org you belong to (org_...), personal or workspace, to report instead of the default. A workspace API key may name only its own workspace. An org you are not a member of, or that does not exist, answers `404 not_found`, as `GET /v1/orgs/{id}` does."}},"responses":{"962bea41-c4fb-4d22-9c14-400affcc01c6":{"description":"Usage as of `computedAt`, and the limits.","content":{"application/json":{"schema":{"type":"object","required":["computedAt","logicalBytes","storedBytes","exclusiveBytes","machines","snapshots","images","limits"],"properties":{"computedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the byte figures were last computed or confirmed. A usage run every 10 minutes confirms unchanged orgs and recomputes changed ones (each at most every 30 minutes), so usually under an hour old. An org that stores nothing reads 0 as of now; null only while stored data waits for its first run.","isRequired":true,"uniqueKey":"computedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the byte figures were last computed or confirmed. A usage run every 10 minutes confirms unchanged orgs and recomputes changed ones (each at most every 30 minutes), so usually under an hour old. An org that stores nothing reads 0 as of now; null only while stored data waits for its first run.","isRequired":true,"uniqueKey":"computedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"computedAt","typeLabel":"string\u003cdate-time> | null"},"logicalBytes":{"type":"integer","format":"int64","description":"Full size of your sandboxes and snapshots.","isRequired":true,"uniqueKey":"logicalBytes","typeLabel":"integer\u003cint64>"},"storedBytes":{"type":"integer","format":"int64","description":"What they take up once compressed, with shared data counted once and the templates' own content (an unchanged root filesystem) not counted: what you wrote on the root filesystem counts. Paused sandboxes' saved memory does not count.","isRequired":true,"uniqueKey":"storedBytes","typeLabel":"integer\u003cint64>"},"exclusiveBytes":{"type":"integer","format":"int64","deprecated":true,"description":"No longer computed: always 0. (Was the part of storedBytes no other org shares.)","isRequired":true,"uniqueKey":"exclusiveBytes","typeLabel":"integer\u003cint64>"},"machines":{"type":"integer","description":"Your sandboxes, in any state.","isRequired":true,"uniqueKey":"machines","typeLabel":"integer"},"snapshots":{"type":"integer","description":"Your snapshots.","isRequired":true,"uniqueKey":"snapshots","typeLabel":"integer"},"images":{"type":"integer","deprecated":true,"description":"Deprecated: `snapshots` (same value).","isRequired":true,"uniqueKey":"images","typeLabel":"integer"},"limits":{"type":"object","required":["maxMachines","maxSnapshots","maxStoredGiB","maxImages"],"description":"Your limits. An admin may change maxMachines per user.","properties":{"maxMachines":{"type":"integer","description":"Sandboxes in any state, checked on create (default 1). 0 with maxMachines in `unlimited`: no limit (a paid plan without one); 0 otherwise: none allowed. There are no vCPU or memory quotas.","isRequired":true,"uniqueKey":"limits.maxMachines","typeLabel":"integer"},"maxSnapshots":{"type":"integer","description":"Saved snapshots. 0: no limit (listed in `unlimited`).","isRequired":true,"uniqueKey":"limits.maxSnapshots","typeLabel":"integer"},"maxStoredGiB":{"type":"integer","description":"Stored data limit (default 200), checked against allocatedDiskGiB when you create a sandbox or snapshot. 0: no limit (listed in `unlimited`).","isRequired":true,"uniqueKey":"limits.maxStoredGiB","typeLabel":"integer"},"maxImages":{"type":"integer","deprecated":true,"description":"Deprecated: `maxSnapshots` (same value).","isRequired":true,"uniqueKey":"limits.maxImages","typeLabel":"integer"},"machineSpec":{"type":"object","description":"The default size, what a create naming no size gets (4 vCPUs, 8 GiB memory by default; no rootDiskGiB: the template's). Absent from servers before fixed sizes.","required":["vcpus","memMiB","persistentDiskGiB"],"properties":{"vcpus":{"type":"integer","isRequired":true,"uniqueKey":"limits.machineSpec.vcpus","typeLabel":"integer"},"memMiB":{"type":"integer","description":"Memory in MiB.","isRequired":true,"uniqueKey":"limits.machineSpec.memMiB","typeLabel":"integer"},"persistentDiskGiB":{"type":"integer","description":"Disk (`/data`) size in GiB.","isRequired":true,"uniqueKey":"limits.machineSpec.persistentDiskGiB","typeLabel":"integer"},"rootDiskGiB":{"type":"integer","description":"System disk size in GiB, set by the template (only admins change it); absent: the template's.","uniqueKey":"limits.machineSpec.rootDiskGiB","typeLabel":"integer"}},"uniqueKey":"limits.machineSpec","typeLabel":"object"},"machineSpecs":{"type":"array","items":{"type":"object","description":"A sandbox's size.","required":["vcpus","memMiB","persistentDiskGiB"],"properties":{"vcpus":{"type":"integer","isRequired":true,"uniqueKey":"limits.machineSpecs.items.[INDEX].vcpus","typeLabel":"integer"},"memMiB":{"type":"integer","description":"Memory in MiB.","isRequired":true,"uniqueKey":"limits.machineSpecs.items.[INDEX].memMiB","typeLabel":"integer"},"persistentDiskGiB":{"type":"integer","description":"Disk (`/data`) size in GiB.","isRequired":true,"uniqueKey":"limits.machineSpecs.items.[INDEX].persistentDiskGiB","typeLabel":"integer"},"rootDiskGiB":{"type":"integer","description":"System disk size in GiB, set by the template (only admins change it); absent: the template's.","uniqueKey":"limits.machineSpecs.items.[INDEX].rootDiskGiB","typeLabel":"integer"}},"uniqueKey":"limits.machineSpecs.items.[INDEX]","typeLabel":"object"},"description":"Every size your new sandboxes may have in your personal org, as `GET /v1/me` `allowedSpecs`: machineSpec first, then its plan's others (Pro: 2/4, 4/8, 8/16; Builder: 2/4 up to 16/32; Team and Enterprise: 2/4 up to 32/64) and any size an admin granted it. Pick one by naming its vcpus and memMiB on create.","uniqueKey":"limits.machineSpecs","typeLabel":"object[]"},"liveSnapshots":{"type":"boolean","description":"Snapshots of running sandboxes are allowed (some may still be refused until the server is fully updated). Absent: they are not.","uniqueKey":"limits.liveSnapshots","typeLabel":"boolean"},"vault":{"type":"object","description":"Vault limits per user; also used for org Secret quotas when orgSecrets is true.","required":["maxItems","maxBytes"],"properties":{"maxItems":{"type":"integer","description":"Secrets per org (server default 100).","isRequired":true,"uniqueKey":"limits.vault.maxItems","typeLabel":"integer"},"maxBytes":{"type":"integer","description":"Raw bytes of all Secret values per org (server default 262144).","isRequired":true,"uniqueKey":"limits.vault.maxBytes","typeLabel":"integer"}},"uniqueKey":"limits.vault","typeLabel":"object"},"orgSecrets":{"type":"boolean","description":"Org Secret APIs are available alongside the per-user Vault. Absent or false: use Vault.","uniqueKey":"limits.orgSecrets","typeLabel":"boolean"},"unlimited":{"oneOf":[{"type":"array","items":{"type":"string","enum":["maxMachines","maxSnapshots","maxImages","maxStoredGiB"],"uniqueKey":"limits.unlimited.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The count limits above that do not apply. Each is still sent as 0 for older clients, but means no limit, not none allowed; a 0 not listed is a real 0 (a free org's maxMachines 0: no free sandboxes). Always an array from current servers (empty when every limit applies); absent or null from older ones, whose 0 is ambiguous. A 0 in a limit means unlimited when the limit's name is in this list.","uniqueKey":"limits.unlimited.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","enum":["maxMachines","maxSnapshots","maxImages","maxStoredGiB"]},"description":"The count limits above that do not apply. Each is still sent as 0 for older clients, but means no limit, not none allowed; a 0 not listed is a real 0 (a free org's maxMachines 0: no free sandboxes). Always an array from current servers (empty when every limit applies); absent or null from older ones, whose 0 is ambiguous. A 0 in a limit means unlimited when the limit's name is in this list.","uniqueKey":"limits.unlimited.oneOf.1","typeLabel":"null"}],"uniqueKey":"limits.unlimited","typeLabel":"enum\u003cstring>[] | null"}},"isRequired":true,"uniqueKey":"limits","typeLabel":"object"},"allocatedDiskGiB":{"type":"integer","description":"The `/data` of all your live sandboxes, in GiB: what `limits.maxStoredGiB` is checked against. Absent from older servers.","uniqueKey":"allocatedDiskGiB","typeLabel":"integer"},"storage":{"type":"object","description":"storedBytes by sandbox. Absent before your first measurement, and from older servers.","required":["machines","deletedMachineSnapshots","deletedMachineSnapshotBytes"],"properties":{"machines":{"type":"array","items":{"type":"object","required":["id","name","state","sizeBytes","diskBytes","snapshots","snapshotBytes"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"storage.machines.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"storage.machines.items.[INDEX].name","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"storage.machines.items.[INDEX].state","typeLabel":"string"},"sizeBytes":{"type":"integer","format":"int64","description":"Size of its storage (`/data`).","isRequired":true,"uniqueKey":"storage.machines.items.[INDEX].sizeBytes","typeLabel":"integer\u003cint64>"},"diskBytes":{"type":"integer","format":"int64","description":"Its saved disks' share of storedBytes: `/data` and what was written on the root filesystem (0 until its disks are first saved, on stop, pause or snapshot).","isRequired":true,"uniqueKey":"storage.machines.items.[INDEX].diskBytes","typeLabel":"integer\u003cint64>"},"snapshots":{"type":"integer","description":"Its snapshots.","isRequired":true,"uniqueKey":"storage.machines.items.[INDEX].snapshots","typeLabel":"integer"},"snapshotBytes":{"type":"integer","format":"int64","description":"Their share.","isRequired":true,"uniqueKey":"storage.machines.items.[INDEX].snapshotBytes","typeLabel":"integer\u003cint64>"}},"uniqueKey":"storage.machines.items.[INDEX]","typeLabel":"object"},"description":"Your sandboxes.","isRequired":true,"uniqueKey":"storage.machines","typeLabel":"object[]"},"deletedMachineSnapshots":{"type":"integer","description":"Snapshots whose sandbox is deleted.","isRequired":true,"uniqueKey":"storage.deletedMachineSnapshots","typeLabel":"integer"},"deletedMachineSnapshotBytes":{"type":"integer","format":"int64","description":"Their share of storedBytes.","isRequired":true,"uniqueKey":"storage.deletedMachineSnapshotBytes","typeLabel":"integer\u003cint64>"}},"uniqueKey":"storage","typeLabel":"object"},"cost":{"type":"object","description":"This calendar month's (UTC) cost in USD as the hourly rating priced it (`costUSD`, with `runtimeUSD`, `storageUSD` and `egressUSD`), up to `ratedUntil`; the allowance (`allowanceUSD`, `creditRemainingUSD`, `overageUSD`) and the credit balance (`creditsUSD`, `creditsExpireAt`). The same figures as `usage` on `GET /v1/orgs/{id}`. A free sandbox is never billed, so a free month is `0`. Absent from older servers.","required":["periodStart","periodEnd","machines","freeMachines","freeSandboxHours","running","snapshots","vcpuHours","memGiBHours","storageGiBHours","egressGiB","runtimeUSD","vcpuUSD","memUSD","storageUSD","egressUSD","costUSD","allowanceUSD","creditRemainingUSD","overageUSD","remainingUSD","ratedUntil","billableDiskGiB","allocatedDiskGiB","storedBytes","storageComputedAt","creditsUSD","creditsUsedUSD"],"properties":{"periodStart":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"cost.periodStart","typeLabel":"string\u003cdate-time>"},"periodEnd":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"cost.periodEnd","typeLabel":"string\u003cdate-time>"},"machines":{"type":"integer","description":"Live sandboxes now.","isRequired":true,"uniqueKey":"cost.machines","typeLabel":"integer"},"freeMachines":{"type":"integer","description":"Of them, the free sandboxes (never billed).","isRequired":true,"uniqueKey":"cost.freeMachines","typeLabel":"integer"},"freeSandboxHours":{"type":"number","description":"The free sandboxes' running time this month.","isRequired":true,"uniqueKey":"cost.freeSandboxHours","typeLabel":"number"},"running":{"type":"integer","description":"The paid sandboxes running or starting now: what `limits.maxRunning` is checked against when a sandbox is created, started or resumed.","isRequired":true,"uniqueKey":"cost.running","typeLabel":"integer"},"snapshots":{"type":"integer","description":"Live snapshots now.","isRequired":true,"uniqueKey":"cost.snapshots","typeLabel":"integer"},"billableDiskGiB":{"type":"number","description":"The disk being billed now: the sum over the org's paid sandboxes of their allocated `/data` (less `freeDiskGiBPerSandbox` each, 0 by default), less `includedDiskGiB`; 0 while the org is past due or disabled (nothing is rated then), and without sandboxes of an earlier account life.","isRequired":true,"uniqueKey":"cost.billableDiskGiB","typeLabel":"number"},"allocatedDiskGiB":{"type":"integer","description":"The `/data` of all the org's live sandboxes, free ones included, in GiB: what `limits.maxStoredGiB` is checked against.","isRequired":true,"uniqueKey":"cost.allocatedDiskGiB","typeLabel":"integer"},"storedBytes":{"oneOf":[{"type":"integer","format":"int64","deprecated":true,"description":"Deprecated: always null. Storage is billed on allocated disk, not stored bytes; use `billableDiskGiB`.","isRequired":true,"uniqueKey":"cost.storedBytes.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","deprecated":true,"description":"Deprecated: always null. Storage is billed on allocated disk, not stored bytes; use `billableDiskGiB`.","isRequired":true,"uniqueKey":"cost.storedBytes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cost.storedBytes","typeLabel":"integer\u003cint64> | null"},"storageComputedAt":{"oneOf":[{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated: always null.","isRequired":true,"uniqueKey":"cost.storageComputedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","deprecated":true,"description":"Deprecated: always null.","isRequired":true,"uniqueKey":"cost.storageComputedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cost.storageComputedAt","typeLabel":"string\u003cdate-time> | null"},"creditsUSD":{"type":"number","description":"What the org's unexpired credits have left: they pay a plan's fee and usage beyond the allowance (docs/pricing.md, Credits).","isRequired":true,"uniqueKey":"cost.creditsUSD","typeLabel":"number"},"creditsUsedUSD":{"type":"number","description":"What credits paid this month.","isRequired":true,"uniqueKey":"cost.creditsUsedUSD","typeLabel":"number"},"vcpuHours":{"type":"number","isRequired":true,"uniqueKey":"cost.vcpuHours","typeLabel":"number"},"memGiBHours":{"type":"number","isRequired":true,"uniqueKey":"cost.memGiBHours","typeLabel":"number"},"storageGiBHours":{"type":"number","description":"Allocated disk (`/data`) of the paid sandboxes (less `freeDiskGiBPerSandbox` each, 0 by default) beyond the plan's `includedDiskGiB` each hour, in GiB-hours.","isRequired":true,"uniqueKey":"cost.storageGiBHours","typeLabel":"number"},"egressGiB":{"type":"number","description":"Egress to the public internet beyond the plan's free egress this month (metered per machine, rated hourly).","isRequired":true,"uniqueKey":"cost.egressGiB","typeLabel":"number"},"runtimeUSD":{"type":"number","description":"Compute: `vcpuUSD` plus `memUSD`.","isRequired":true,"uniqueKey":"cost.runtimeUSD","typeLabel":"number"},"vcpuUSD":{"type":"number","description":"The vCPU part of compute.","isRequired":true,"uniqueKey":"cost.vcpuUSD","typeLabel":"number"},"memUSD":{"type":"number","description":"The memory part of compute.","isRequired":true,"uniqueKey":"cost.memUSD","typeLabel":"number"},"storageUSD":{"type":"number","isRequired":true,"uniqueKey":"cost.storageUSD","typeLabel":"number"},"egressUSD":{"type":"number","isRequired":true,"uniqueKey":"cost.egressUSD","typeLabel":"number"},"costUSD":{"type":"number","description":"This month's usage so far, at the prices in force when rated.","isRequired":true,"uniqueKey":"cost.costUSD","typeLabel":"number"},"allowanceUSD":{"type":"number","description":"Usage the month includes: the free credit, or what the subscription paid for.","isRequired":true,"uniqueKey":"cost.allowanceUSD","typeLabel":"number"},"creditRemainingUSD":{"type":"number","description":"The allowance left.","isRequired":true,"uniqueKey":"cost.creditRemainingUSD","typeLabel":"number"},"overageUSD":{"type":"number","description":"Usage beyond the allowance (billed at month end on a paid tier).","isRequired":true,"uniqueKey":"cost.overageUSD","typeLabel":"number"},"remainingUSD":{"type":"number","description":"What may still be used before the org is stopped; 0 when there is no limit or nothing is left (see `limits`).","isRequired":true,"uniqueKey":"cost.remainingUSD","typeLabel":"number"},"ratedUntil":{"type":"string","format":"date-time","description":"The rating job's cursor.","isRequired":true,"uniqueKey":"cost.ratedUntil","typeLabel":"string\u003cdate-time>"},"freeDiskGiBPerSandbox":{"type":"number","description":"The `/data` of each paid sandbox that is not billed, in GiB: 0 by default (every allocated GiB is billed); an operator may configure more. Absent from older servers, which did not bill the first 20 GiB.","uniqueKey":"cost.freeDiskGiBPerSandbox","typeLabel":"number"},"includedDiskGiB":{"type":"number","description":"The disk the org's plan includes, all its paid sandboxes' `/data` together, in GiB (Pro 200, Builder 1024, Team and Enterprise 5120): each hour that much is not billed. Absent from older servers, which included none.","uniqueKey":"cost.includedDiskGiB","typeLabel":"number"},"creditsExpireAt":{"type":"string","format":"date-time","description":"When the earliest of the credits expires.","uniqueKey":"cost.creditsExpireAt","typeLabel":"string\u003cdate-time>"},"chargedUSD":{"type":"number","description":"Usage beyond the allowance already charged this month (threshold billing); the month's end bills overageUSD less it.","uniqueKey":"cost.chargedUSD","typeLabel":"number"}},"uniqueKey":"cost","typeLabel":"object"},"org":{"type":"object","description":"The org these figures and limits describe: your personal org by default, a workspace key's workspace, or the one named with `org`. Absent from older servers.","required":["id","name","tier","kind"],"properties":{"id":{"type":"string","description":"Org ID (org_...).","isRequired":true,"uniqueKey":"org.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"org.name","typeLabel":"string"},"tier":{"type":"string","enum":["free","pro","builder","team","enterprise"],"description":"The org's plan.","isRequired":true,"uniqueKey":"org.tier","typeLabel":"enum\u003cstring>"},"kind":{"type":"string","enum":["personal","workspace"],"isRequired":true,"uniqueKey":"org.kind","typeLabel":"enum\u003cstring>"},"alwaysOnAllowed":{"type":"boolean","description":"Set on `GET /v1/me` (`org`, `workspaces`): this org's plan lets its sandboxes take `autoSuspendAfterSeconds` 0 (off). Absent on a plan that does not, elsewhere, and from older servers.","uniqueKey":"org.alwaysOnAllowed","typeLabel":"boolean"}},"uniqueKey":"org","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"computedAt":"2023-11-07T05:31:56Z","logicalBytes":123,"storedBytes":123,"exclusiveBytes":123,"machines":123,"snapshots":123,"images":123,"limits":{"maxMachines":123,"maxSnapshots":123,"maxStoredGiB":123,"maxImages":123,"machineSpec":{"vcpus":123,"memMiB":123,"persistentDiskGiB":123,"rootDiskGiB":123},"machineSpecs":[{"vcpus":123,"memMiB":123,"persistentDiskGiB":123,"rootDiskGiB":123}],"liveSnapshots":true,"vault":{"maxItems":123,"maxBytes":123},"orgSecrets":true,"unlimited":["maxMachines"]},"allocatedDiskGiB":123,"storage":{"machines":[{"id":"\u003cstring>","name":"\u003cstring>","state":"\u003cstring>","sizeBytes":123,"diskBytes":123,"snapshots":123,"snapshotBytes":123}],"deletedMachineSnapshots":123,"deletedMachineSnapshotBytes":123},"cost":{"periodStart":"2023-11-07T05:31:56Z","periodEnd":"2023-11-07T05:31:56Z","machines":123,"freeMachines":123,"freeSandboxHours":123,"running":123,"snapshots":123,"billableDiskGiB":123,"allocatedDiskGiB":123,"storedBytes":123,"storageComputedAt":"2023-11-07T05:31:56Z","creditsUSD":123,"creditsUsedUSD":123,"vcpuHours":123,"memGiBHours":123,"storageGiBHours":123,"egressGiB":123,"runtimeUSD":123,"vcpuUSD":123,"memUSD":123,"storageUSD":123,"egressUSD":123,"costUSD":123,"allowanceUSD":123,"creditRemainingUSD":123,"overageUSD":123,"remainingUSD":123,"ratedUntil":"2023-11-07T05:31:56Z","freeDiskGiBPerSandbox":123,"includedDiskGiB":123,"creditsExpireAt":"2023-11-07T05:31:56Z","chargedUSD":123},"org":{"id":"\u003cstring>","name":"\u003cstring>","tier":"free","kind":"personal","alwaysOnAllowed":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"876fbe05-fb9a-428f-8674-3f7033211780":{"description":"A credential 401 has its own code: `missing_key`, `malformed_key`, `invalid_key`, `expired_key`, `revoked_key` or `session_expired`, with `hint` and `docs` (older servers sent `unauthenticated`, `api_key_expired` or `api_key_revoked`). Other 401s (refresh tokens, tickets) are `unauthenticated`. For a missing or bad API key or access token the message ends with how to get a key (session and refresh-token 401s say to sign in again instead), e.g. `create an API key at https://dashboard.instabox.sh/dashboard/api-keys and send it as \"Authorization: Bearer \u003ckey>\" or \"X-API-Key: \u003ckey>\"`.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId","retryable","operationId"],"properties":{"code":{"type":"string","description":"Machine-readable code. HTTP status per code is fixed.","enum":["unauthenticated","missing_key","malformed_key","invalid_key","expired_key","revoked_key","session_expired","missing_scope","permission_denied","not_found","bad_request","feature_disabled","unknown_field","operation_conflict","idempotency_conflict","machine_not_running","restore_unavailable","delete_confirmation_required","fork_unavailable","machine_cooldown","max_run_disabled","desktop_not_running","disk_too_small","grow_needs_stop","resize_restart_off","private_ports_unavailable","quota_exceeded","no_capacity","host_unavailable","metrics_unavailable","restore_failed","internal","authorization_pending","slow_down","expired_token","access_denied","invalid_grant","invite_required","invite_invalid","invite_email_mismatch","api_key_expired","api_key_revoked","insufficient_scope","orca_unsupported","runtime_not_ready","spec_not_allowed","template_not_allowed","template_limit","kernel_unavailable","template_unavailable","invalid_guest_user","vault_unavailable","vault_retired","credit_exhausted","spend_limit_reached","subscription_required","payment_method_required","early_allowance_ended","rate_limited","concurrency_limit","payment_failed","missing_parent","not_a_file","no_space","too_large","data_disk_not_browsable","support_unavailable","host_oom","vmm_crashed","guest_reboot_loop"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"retryable":{"type":"boolean","description":"True if the same request may succeed later.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"operationId":{"oneOf":[{"type":"string","description":"For `operation_conflict`, the active operation.","isRequired":true,"uniqueKey":"error.operationId.oneOf.0","typeLabel":"string"},{"type":"null","description":"For `operation_conflict`, the active operation.","isRequired":true,"uniqueKey":"error.operationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.operationId","typeLabel":"string | null"},"reason":{"type":"string","description":"The same as `code` for credential errors (401 `missing_key`, `malformed_key`, `invalid_key`, `expired_key`, `revoked_key`, `session_expired`; 403 `missing_scope`). For 409 `machine_cooldown`, the automatic abuse check whose pause locks the sandbox: `abuse_egress_blocklist` (it tried to connect to a blocked destination on the egress blocklist, not a DNS lookup), `abuse_network_flows` (scanning or attack traffic), `abuse_cpu` (mining); absent for a max-run cooldown. For a retryable 409 `fork_unavailable`, why the source's host cannot take the fork: `source_host_unavailable` (it takes no new sandboxes) or `source_host_full` (no room now). Absent on other errors and from older servers.","enum":["missing_key","malformed_key","invalid_key","expired_key","revoked_key","session_expired","missing_scope","abuse_egress_blocklist","abuse_network_flows","abuse_cpu","source_host_unavailable","source_host_full"],"uniqueKey":"error.reason","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"The next step that fixes the error (credential errors). Absent otherwise.","uniqueKey":"error.hint","typeLabel":"string"},"docs":{"type":"string","format":"uri","description":"A URL documenting the error (credential errors). Absent otherwise.","uniqueKey":"error.docs","typeLabel":"string\u003curi>"},"docs_url":{"type":"string","format":"uri","description":"The code's entry on the errors page, on every error response: https://instabox.sh/docs/errors#\u003ccode> with underscores as dashes (e.g. #credit-exhausted): its HTTP status, whether to retry and what to do. Snake case, unlike the other fields. Absent from a failed operation's `error` and from older servers.","uniqueKey":"error.docs_url","typeLabel":"string\u003curi>"},"requiredScopes":{"type":"array","items":{"type":"string","uniqueKey":"error.requiredScopes.items.[INDEX]","typeLabel":"string"},"description":"For `missing_scope`, the scopes the route accepts; the key needs one of them.","uniqueKey":"error.requiredScopes","typeLabel":"string[]"},"retryAfterSeconds":{"type":"integer","minimum":1,"description":"Seconds to wait before trying again: a retryable `no_capacity` (60, as a 503 or on a failed operation's `error`), `rate_limited`, `machine_cooldown` and agent sign-up `quota_exceeded`. An error response also sends it as the `Retry-After` header; a failed operation's `error` has only this field. Absent otherwise and from older servers.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"at":{"type":"string","format":"date-time","description":"When it happened, for a stop the platform found (a sandbox's `lastError` with code `host_oom`, `vmm_crashed` or `guest_reboot_loop`; `hint` says what to do). The next successful start clears the error. Absent otherwise and from older servers.","uniqueKey":"error.at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthenticated","message":"\u003cstring>","requestId":"\u003cstring>","retryable":true,"operationId":"\u003cstring>","reason":"missing_key","hint":"\u003cstring>","docs":"\u003cstring>","docs_url":"\u003cstring>","requiredScopes":["\u003cstring>"],"retryAfterSeconds":2,"at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9ffc0d99-ca84-460b-baa5-517f7397830a":{"description":"`not_found`: no such resource (also for deleted sandboxes).","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId","retryable","operationId"],"properties":{"code":{"type":"string","description":"Machine-readable code. HTTP status per code is fixed.","enum":["unauthenticated","missing_key","malformed_key","invalid_key","expired_key","revoked_key","session_expired","missing_scope","permission_denied","not_found","bad_request","feature_disabled","unknown_field","operation_conflict","idempotency_conflict","machine_not_running","restore_unavailable","delete_confirmation_required","fork_unavailable","machine_cooldown","max_run_disabled","desktop_not_running","disk_too_small","grow_needs_stop","resize_restart_off","private_ports_unavailable","quota_exceeded","no_capacity","host_unavailable","metrics_unavailable","restore_failed","internal","authorization_pending","slow_down","expired_token","access_denied","invalid_grant","invite_required","invite_invalid","invite_email_mismatch","api_key_expired","api_key_revoked","insufficient_scope","orca_unsupported","runtime_not_ready","spec_not_allowed","template_not_allowed","template_limit","kernel_unavailable","template_unavailable","invalid_guest_user","vault_unavailable","vault_retired","credit_exhausted","spend_limit_reached","subscription_required","payment_method_required","early_allowance_ended","rate_limited","concurrency_limit","payment_failed","missing_parent","not_a_file","no_space","too_large","data_disk_not_browsable","support_unavailable","host_oom","vmm_crashed","guest_reboot_loop"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"retryable":{"type":"boolean","description":"True if the same request may succeed later.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"operationId":{"oneOf":[{"type":"string","description":"For `operation_conflict`, the active operation.","isRequired":true,"uniqueKey":"error.operationId.oneOf.0","typeLabel":"string"},{"type":"null","description":"For `operation_conflict`, the active operation.","isRequired":true,"uniqueKey":"error.operationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.operationId","typeLabel":"string | null"},"reason":{"type":"string","description":"The same as `code` for credential errors (401 `missing_key`, `malformed_key`, `invalid_key`, `expired_key`, `revoked_key`, `session_expired`; 403 `missing_scope`). For 409 `machine_cooldown`, the automatic abuse check whose pause locks the sandbox: `abuse_egress_blocklist` (it tried to connect to a blocked destination on the egress blocklist, not a DNS lookup), `abuse_network_flows` (scanning or attack traffic), `abuse_cpu` (mining); absent for a max-run cooldown. For a retryable 409 `fork_unavailable`, why the source's host cannot take the fork: `source_host_unavailable` (it takes no new sandboxes) or `source_host_full` (no room now). Absent on other errors and from older servers.","enum":["missing_key","malformed_key","invalid_key","expired_key","revoked_key","session_expired","missing_scope","abuse_egress_blocklist","abuse_network_flows","abuse_cpu","source_host_unavailable","source_host_full"],"uniqueKey":"error.reason","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"The next step that fixes the error (credential errors). Absent otherwise.","uniqueKey":"error.hint","typeLabel":"string"},"docs":{"type":"string","format":"uri","description":"A URL documenting the error (credential errors). Absent otherwise.","uniqueKey":"error.docs","typeLabel":"string\u003curi>"},"docs_url":{"type":"string","format":"uri","description":"The code's entry on the errors page, on every error response: https://instabox.sh/docs/errors#\u003ccode> with underscores as dashes (e.g. #credit-exhausted): its HTTP status, whether to retry and what to do. Snake case, unlike the other fields. Absent from a failed operation's `error` and from older servers.","uniqueKey":"error.docs_url","typeLabel":"string\u003curi>"},"requiredScopes":{"type":"array","items":{"type":"string","uniqueKey":"error.requiredScopes.items.[INDEX]","typeLabel":"string"},"description":"For `missing_scope`, the scopes the route accepts; the key needs one of them.","uniqueKey":"error.requiredScopes","typeLabel":"string[]"},"retryAfterSeconds":{"type":"integer","minimum":1,"description":"Seconds to wait before trying again: a retryable `no_capacity` (60, as a 503 or on a failed operation's `error`), `rate_limited`, `machine_cooldown` and agent sign-up `quota_exceeded`. An error response also sends it as the `Retry-After` header; a failed operation's `error` has only this field. Absent otherwise and from older servers.","uniqueKey":"error.retryAfterSeconds","typeLabel":"integer"},"at":{"type":"string","format":"date-time","description":"When it happened, for a stop the platform found (a sandbox's `lastError` with code `host_oom`, `vmm_crashed` or `guest_reboot_loop`; `hint` says what to do). The next successful start clears the error. Absent otherwise and from older servers.","uniqueKey":"error.at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthenticated","message":"\u003cstring>","requestId":"\u003cstring>","retryable":true,"operationId":"\u003cstring>","reason":"missing_key","hint":"\u003cstring>","docs":"\u003cstring>","docs_url":"\u003cstring>","requiredScopes":["\u003cstring>"],"retryAfterSeconds":2,"at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b38b9c01-422f-4cb8-a804-a9defdea6f7f":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Opaque instabox access token (1 hour). Refresh with `/v1/auth/refresh` (refresh token valid 30 days, rotates on use).","scopes":[],"schemeName":"bearerAuth"}},"3ee83008-a74d-4e34-ab14-2ffb2028f8e9":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key (`ibk_...`) with scopes; also accepted as `Authorization: Bearer ibk_...`.\nAccepted on sandbox, snapshot, operation, template and usage routes per scope\n(see API keys), never on key management, sessions, logout or admin routes.\n","scopes":[],"schemeName":"apiKey"}},"f47084a2-cd12-4366-9dd2-cf274879cefa":{"sessionCookie":{"type":"apiKey","in":"cookie","name":"instabox_session","description":"Dashboard browser session from `/auth/github/login` (7 days idle, 30 days at\nmost). Used only when no Authorization header is sent. Requests other than\nGET and HEAD must send `X-Instabox-CSRF` (from `GET /v1/me`) and an `Origin`\nequal to the server's `publicUrl`; otherwise `403 permission_denied`.\n","scopes":[],"schemeName":"sessionCookie"}}},"servers":{"e2c665bb-4b53-46fa-8dd3-3dba6e3ac4a8":{"url":"https://api.instabox.sh"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Opaque instabox access token (1 hour). Refresh with `/v1/auth/refresh` (refresh token valid 30 days, rotates on use).","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Opaque instabox access token (1 hour). Refresh with `/v1/auth/refresh` (refresh token valid 30 days, rotates on use).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key (`ibk_...`) with scopes; also accepted as `Authorization: Bearer ibk_...`.\nAccepted on sandbox, snapshot, operation, template and usage routes per scope\n(see API keys), never on key management, sessions, logout or admin routes.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","description":"API key (`ibk_...`) with scopes; also accepted as `Authorization: Bearer ibk_...`.\nAccepted on sandbox, snapshot, operation, template and usage routes per scope\n(see API keys), never on key management, sessions, logout or admin routes.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"},{"schemes":[{"scheme":{"type":"apiKey","in":"cookie","name":"instabox_session","description":"Dashboard browser session from `/auth/github/login` (7 days idle, 30 days at\nmost). Used only when no Authorization header is sent. Requests other than\nGET and HEAD must send `X-Instabox-CSRF` (from `GET /v1/me`) and an `Origin`\nequal to the server's `publicUrl`; otherwise `403 permission_denied`.\n","scopes":[],"schemeName":"sessionCookie"},"schema":{"title":"instabox_session","type":"string","description":"Dashboard browser session from `/auth/github/login` (7 days idle, 30 days at\nmost). Used only when no Authorization header is sent. Requests other than\nGET and HEAD must send `X-Instabox-CSRF` (from `GET /v1/me`) and an `Origin`\nequal to the server's `publicUrl`; otherwise `403 permission_denied`.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"sessionCookie","name":"instabox_session"}],"title":"sessionCookie"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"instacloud","siteName":"InstaBox","title":"Your storage use, limits, this month's cost and credit balance. - InstaBox","relatedPagesConfig":{"enabled":false,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T06:53:04.077Z","originalFileLocation":"api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Your personal org\u0026#x27;s sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace\u0026#x27;s API key, that workspace\u0026#x27;s; with org, that org\u0026#x27;s. org in the answer names the org it describes. cost is the org\u0026#x27;s cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as usage on GET /v1/orgs/{id}). Stored data is as of computedAt, usually under an hour old. API keys: needs one of the scopes machines:read, images:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"InstaBox\">\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/instacloud/B4TOiHlk6CDYfBRt/_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/instacloud/B4TOiHlk6CDYfBRt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/instacloud/B4TOiHlk6CDYfBRt/_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/instacloud/B4TOiHlk6CDYfBRt/_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/instacloud/B4TOiHlk6CDYfBRt/_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/instacloud/B4TOiHlk6CDYfBRt/_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/instacloud/B4TOiHlk6CDYfBRt/_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/instacloud/B4TOiHlk6CDYfBRt/_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/instacloud/B4TOiHlk6CDYfBRt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Your storage use, limits, this month\u0026#x27;s cost and credit balance. - InstaBox\">\u003cmeta data-mint-head property=\"og:description\" content=\"Your personal org\u0026#x27;s sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace\u0026#x27;s API key, that workspace\u0026#x27;s; with org, that org\u0026#x27;s. org in the answer names the org it describes. cost is the org\u0026#x27;s cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as usage on GET /v1/orgs/{id}). Stored data is as of computedAt, usually under an hour old. API keys: needs one of the scopes machines:read, images:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"InstaBox\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://instacloud.mintlify.site/docs/_mintlify/api/og/v2?division=Account\u0026amp;title=Your+storage+use%2C+limits%2C+this+month%27s+cost+and+credit+balance.\u0026amp;description=Your+personal+org%27s+sandbox+and+snapshot+counts%2C+the+stored+data+they+take+up%2C+and+its+limits+%28free%3A+1+sandbox%2C+5+snapshots%2C+200+GiB+of+stored+data+by+default%29%3B\u0026amp;theme=4d60089f83d6d00671834b24\u0026amp;signature=1c3dc3f6e3be8db7497146707cf1de7a72ee016846aa7a3f13a281faba23dd9b\">\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=\"Your storage use, limits, this month\u0026#x27;s cost and credit balance. - InstaBox\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Your personal org\u0026#x27;s sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace\u0026#x27;s API key, that workspace\u0026#x27;s; with org, that org\u0026#x27;s. org in the answer names the org it describes. cost is the org\u0026#x27;s cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as usage on GET /v1/orgs/{id}). Stored data is as of computedAt, usually under an hour old. API keys: needs one of the scopes machines:read, images:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://instacloud.mintlify.site/docs/_mintlify/api/og/v2?division=Account\u0026amp;title=Your+storage+use%2C+limits%2C+this+month%27s+cost+and+credit+balance.\u0026amp;description=Your+personal+org%27s+sandbox+and+snapshot+counts%2C+the+stored+data+they+take+up%2C+and+its+limits+%28free%3A+1+sandbox%2C+5+snapshots%2C+200+GiB+of+stored+data+by+default%29%3B\u0026amp;theme=4d60089f83d6d00671834b24\u0026amp;signature=1c3dc3f6e3be8db7497146707cf1de7a72ee016846aa7a3f13a281faba23dd9b\">\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/instacloud/B4TOiHlk6CDYfBRt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"InstaBox\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance\">\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/usage/your-storage-use-limits-this-months-cost-and-credit-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://instabox.sh/#organization\",\"name\":\"InstaBox\",\"url\":\"https://instabox.sh\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://instacloud.mintlify.site/docs/logo/light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://instabox.sh/docs#website\",\"name\":\"InstaBox\",\"url\":\"https://instabox.sh/docs\",\"publisher\":{\"@id\":\"https://instabox.sh/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance#webpage\",\"url\":\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance\",\"name\":\"Your storage use, limits, this month's cost and credit balance.\",\"description\":\"Your personal org's sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace's API key, that workspace's; with org, that org's. org in the answer names the org it describes. cost is the org's cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as usage on GET /v1/orgs/{id}). Stored data is as of computedAt, usually under an hour old. API keys: needs one of the scopes machines:read, images:read.\",\"dateModified\":\"2026-11-09T06:53:04.077Z\",\"isPartOf\":{\"@id\":\"https://instabox.sh/docs#website\"},\"breadcrumb\":{\"@id\":\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://instabox.sh/docs/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Account\",\"item\":\"https://instabox.sh/docs/api-reference/auth/the-signed-in-user-and-the-sandbox-size-they-get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Your storage use, limits, this month's cost and credit balance.\",\"item\":\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance#apireference\",\"headline\":\"Your storage use, limits, this month's cost and credit balance.\",\"name\":\"Your storage use, limits, this month's cost and credit balance.\",\"description\":\"Your personal org's sandbox and snapshot counts, the stored data they take up, and its limits (free: 1 sandbox, 5 snapshots, 200 GiB of stored data by default); with a workspace's API key, that workspace's; with org, that org's. org in the answer names the org it describes. cost is the org's cost this calendar month (UTC) in USD and its credit balance, from the hourly rating (the same as usage on GET /v1/orgs/{id}). Stored data is as of computedAt, usually under an hour old. API keys: needs one of the scopes machines:read, images:read.\",\"url\":\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance\",\"mainEntityOfPage\":{\"@id\":\"https://instabox.sh/docs/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance#webpage\"},\"dateModified\":\"2026-11-09T06:53:04.077Z\",\"publisher\":{\"@id\":\"https://instabox.sh/#organization\"},\"isPartOf\":{\"@id\":\"https://instabox.sh/docs#website\"}}]}\u003c/script>","siteName":"InstaBox","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"API reference","pages":[{"title":"API overview","icon":"braces","href":"/api-reference/introduction"},{"group":"Machines","pages":[{"title":"Create a sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines","href":"/api-reference/machines/create-a-sandbox"},{"title":"List the sandboxes of your orgs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/machines","href":"/api-reference/machines/list-the-sandboxes-of-your-orgs"},{"title":"Get a sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/machines/{id}","href":"/api-reference/machines/get-a-sandbox"},{"title":"Rename, resize (vCPUs, memory, disk) a stopped sandbox, or set its idle pause and metadata.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/machines/{id}","href":"/api-reference/machines/rename-resize-vcpus-memory-disk-a-stopped-sandbox-or-set-its-idle-pause-and-metadata"},{"title":"Delete a sandbox, its system files and its storage.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/machines/{id}","href":"/api-reference/machines/delete-a-sandbox-its-system-files-and-its-storage"}]},{"group":"Lifecycle","pages":[{"title":"Start a stopped or paused sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/start","href":"/api-reference/machines/start-a-stopped-or-paused-sandbox"},{"title":"Stop a running sandbox (shuts it down; running programs end, files are kept).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/stop","href":"/api-reference/machines/stop-a-running-sandbox-shuts-it-down;-running-programs-end-files-are-kept"},{"title":"Pause a running sandbox, keeping its running programs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/suspend","href":"/api-reference/machines/pause-a-running-sandbox-keeping-its-running-programs"},{"title":"Resume a paused sandbox where it left off.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/resume","href":"/api-reference/machines/resume-a-paused-sandbox-where-it-left-off"},{"title":"Resume an idle-suspended machine before using it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/wake","href":"/api-reference/machines/resume-an-idle-suspended-machine-before-using-it"},{"title":"Put a sandbox's disks back to a snapshot's, in place.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/restore","href":"/api-reference/machines/put-a-sandboxs-disks-back-to-a-snapshots-in-place"},{"title":"Create a copy of a sandbox on its host, without a snapshot.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/fork","href":"/api-reference/machines/create-a-copy-of-a-sandbox-on-its-host-without-a-snapshot"},{"title":"Get an operation (the progress of a sandbox change).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/operations/{id}","href":"/api-reference/operations/get-an-operation-the-progress-of-a-sandbox-change"}]},{"group":"Commands and files","pages":[{"title":"Run a command in the sandbox and return its output.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/exec","href":"/api-reference/connections/run-a-command-in-the-sandbox-and-return-its-output"},{"title":"Read a file or directory of a running sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/machines/{id}/files","href":"/api-reference/machines/read-a-file-or-directory-of-a-running-sandbox"},{"title":"Write (upload) a file to a running sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/machines/{id}/files","href":"/api-reference/machines/write-upload-a-file-to-a-running-sandbox"},{"title":"Download a file's raw bytes from a running sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/machines/{id}/files/content","href":"/api-reference/machines/download-a-files-raw-bytes-from-a-running-sandbox"},{"title":"Get a short-lived signed URL that uploads one file.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/files/upload-url","href":"/api-reference/machines/get-a-short-lived-signed-url-that-uploads-one-file"}]},{"group":"Snapshots","pages":[{"title":"Save a sandbox's system files and storage as a snapshot.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/snapshots","href":"/api-reference/snapshots/save-a-sandboxs-system-files-and-storage-as-a-snapshot"},{"title":"List the snapshots of your orgs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/snapshots","href":"/api-reference/snapshots/list-the-snapshots-of-your-orgs"},{"title":"Get a snapshot of one of your orgs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/snapshots/{id}","href":"/api-reference/snapshots/get-a-snapshot-of-one-of-your-orgs"},{"title":"Read a file or directory of a snapshot's system files.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/snapshots/{id}/files","href":"/api-reference/snapshots/read-a-file-or-directory-of-a-snapshots-system-files"},{"title":"Delete a snapshot.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/snapshots/{id}","href":"/api-reference/snapshots/delete-a-snapshot"}]},{"group":"Ports","pages":[{"title":"Give one HTTP port of a sandbox an HTTPS URL, public or private.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/ports","href":"/api-reference/give-one-http-port-of-a-sandbox-an-https-url-public-or-private"},{"title":"List a sandbox's public ports.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/machines/{id}/ports","href":"/api-reference/list-a-sandboxs-public-ports"},{"title":"List the public ports of all your sandboxes.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/ports","href":"/api-reference/list-the-public-ports-of-all-your-sandboxes"},{"title":"Remove a port's public URL and close its active connections.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/machines/{id}/ports/{port}","href":"/api-reference/remove-a-ports-public-url-and-close-its-active-connections"}]},{"group":"SSH","pages":[{"title":"Issue an SSH token, for a plain `ssh` command without a key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/ssh-tokens","href":"/api-reference/connections/issue-an-ssh-token-for-a-plain-`ssh`-command-without-a-key"},{"title":"List SSH token metadata, including revoked and recently expired tokens.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/machines/{id}/ssh-tokens","href":"/api-reference/connections/list-ssh-token-metadata-including-revoked-and-recently-expired-tokens"},{"title":"Revoke one SSH token and close its SSH and mosh connections.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/machines/{id}/ssh-tokens/{tokenID}","href":"/api-reference/connections/revoke-one-ssh-token-and-close-its-ssh-and-mosh-connections"},{"title":"Revoke every SSH token of the sandbox and close their connections.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/machines/{id}/ssh-tokens","href":"/api-reference/connections/revoke-every-ssh-token-of-the-sandbox-and-close-their-connections"},{"title":"Issue a short-lived SSH user certificate for the sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/connections","href":"/api-reference/connections/issue-a-short-lived-ssh-user-certificate-for-the-sandbox"}]},{"group":"Secrets","pages":[{"title":"List an org's Secret metadata, never values.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/orgs/{id}/secrets","href":"/api-reference/secrets/list-an-orgs-secret-metadata-never-values"},{"title":"Create or replace an org Secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/orgs/{id}/secrets/{name}","href":"/api-reference/secrets/create-or-replace-an-org-secret"},{"title":"Atomically create or replace a batch of org Secrets.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/orgs/{id}/secrets/import","href":"/api-reference/secrets/atomically-create-or-replace-a-batch-of-org-secrets"},{"title":"Delete an org Secret and its explicit sandbox grants.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/orgs/{id}/secrets/{name}","href":"/api-reference/secrets/delete-an-org-secret-and-its-explicit-sandbox-grants"},{"title":"Read a sandbox's Secret selections and delivery status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/machines/{id}/secrets","href":"/api-reference/secrets/read-a-sandboxs-secret-selections-and-delivery-status"},{"title":"Replace supplied Secret selections for a sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/machines/{id}/secrets","href":"/api-reference/secrets/replace-supplied-secret-selections-for-a-sandbox"},{"title":"Refresh managed Secret delivery in a running sandbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/machines/{id}/secrets","href":"/api-reference/secrets/refresh-managed-secret-delivery-in-a-running-sandbox"}]},{"group":"Account","pages":[{"title":"The signed-in user and the sandbox size they get.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/me","href":"/api-reference/auth/the-signed-in-user-and-the-sandbox-size-they-get"},{"title":"List the templates a sandbox can start from.","description":"API keys: needs one of the scopes `machines:read`, `images:read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/templates","href":"/api-reference/machines/list-the-templates-a-sandbox-can-start-from"},{"title":"Your storage use, limits, this month's cost and credit balance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/usage","href":"/api-reference/usage/your-storage-use-limits-this-months-cost-and-credit-balance"}]}]}]},{"tab":"SDK reference","pages":[{"title":"SDK reference","href":"/integrations/sdk-quickstart"}]}]},"basePath":"","title":"Your storage use, limits, this month's cost and credit balance. - InstaBox","buildId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","deploymentId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CW3yP2DK.js","utils-BN0nty2W.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C8_MydSG.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bsl5xDMQ.js","snippetPresets-DYv9OBej.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-9OnYPrVf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-xr67xWGO.js","shallow-DO1aDdBF.js","getApiPlaygroundDisplay-o7cLzFL-.js","CodeSnippet-CGr2yOA8.js","CodeSnippets-CzBbqPNh.js","Page-CBlOSKZG.js","getPastedJson-dpi9sn5Y.js","icon-aIWHt8Pn.js","MethodPill-Bv2zLsGY.js","DuplicateIcon-DxFSz0J6.js","createIcon-uDNv6jwj.js","DynamicMarkdown-C91yhnNP.js","SectionHeading-DG_xjOLR.js","axios-vUo_bRtp.js","Markdown-B4M_Eo1P.js","clsx-DShopWo_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BX6wab7q.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-48h67xm_.js"]}