MImicrosandbox
quotas

Get quota usage

Changed on
get/v1/orgs/{slug}/quotas

Request

  • Base URL
    https://api.microsandbox.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://api.microsandbox.dev/v1/orgs/{slug}/quotas
  • Auth
    HTTP bearer

Path parameters

slugstring required

Organization slug

Response

Quota usage

hard_capboolean required

Whether the plan hard-stops at its included pools (no overflow). DERIVED (not a stored column): true iff the resolved plan is unpriced — an unpriced plan has no overage path, so its pools become walls.

included_memory_gib_hoursinteger nullable

Included memory GiB-hours/month; None = unlimited.

included_vcpu_hoursinteger nullable

Included vCPU-hours/month; None = unlimited. On hard_cap plans this is the compute wall; on priced plans, usage beyond it is metered overage.

memory_gib_hours_usednumber double required

Memory GiB-hours consumed this billing month (compute-on-read from sandbox_runs).

vcpu_hours_usednumber double required

vCPU-hours consumed this billing month (compute-on-read from sandbox_runs).

concurrent_ephemeral_runninginteger required

Currently running/starting ephemeral sandboxes.

concurrent_persistent_runninginteger required

Currently running/starting persistent sandboxes.

included_disk_gib_hoursinteger nullable

Included writable-disk GiB-hours/month (display/billing only — never a wall).

included_storage_gibinteger nullable

Included durable-storage GiB/month.

is_suspendedboolean required

Whether sandbox usage has been manually suspended for the organization.

max_concurrent_ephemeral_runninginteger nullable

Maximum simultaneously-running ephemeral sandboxes.

max_concurrent_persistent_runninginteger nullable

Maximum simultaneously-running persistent sandboxes.

max_disk_size_mib_per_sandboxinteger nullable

Maximum writable disk size (MiB) per sandbox.

max_memory_mib_per_sandboxinteger nullable

Maximum memory (MiB) per sandbox.

max_sandboxesinteger nullable

Maximum total sandboxes the org can have.

max_snapshot_storage_gibinteger nullable

Per-org managed-snapshot storage hard cap (GiB).

max_total_storage_gibinteger nullable

Per-org durable-storage hard cap (GiB).

max_uptime_minutes_per_sandboxinteger nullable

Maximum uptime per sandbox (minutes), if set.

max_vcpus_per_sandboxinteger nullable

Maximum CPU cores per sandbox.

pool_exhaustedboolean required

Snapshot of [PoolUsage::pool_exhausted] at read time, for API consumers — true when this org's sandboxes are being stopped and starts refused.

snapshot_storage_bytesinteger required

Exact summed compressed archive size (bytes) of the org's managed snapshots — the value snapshot quota enforcement compares.

total_sandboxesinteger required

Total sandboxes (all states) for the org.

Changes

  • b61270559d5eRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

  • 90291f62c817Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status