Skip to main content
GET
Your storage use, limits, this month's cost and credit balance.

Authorizations

Authorization
string
header
required

Opaque instabox access token (1 hour). Refresh with /v1/auth/refresh (refresh token valid 30 days, rotates on use).

Query Parameters

org
string

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.

Response

Usage as of computedAt, and the limits.

computedAt
string<date-time> | null
required

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.

logicalBytes
integer<int64>
required

Full size of your sandboxes and snapshots.

storedBytes
integer<int64>
required

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.

exclusiveBytes
integer<int64>
required
deprecated

No longer computed: always 0. (Was the part of storedBytes no other org shares.)

machines
integer
required

Your sandboxes, in any state.

snapshots
integer
required

Your snapshots.

images
integer
required
deprecated

Deprecated: snapshots (same value).

limits
object
required

Your limits. An admin may change maxMachines per user.

allocatedDiskGiB
integer

The /data of all your live sandboxes, in GiB: what limits.maxStoredGiB is checked against. Absent from older servers.

storage
object

storedBytes by sandbox. Absent before your first measurement, and from older servers.

cost
object

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.

org
object

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.