Get quota usage

GET

quotas

Get quota usage

curl --request GET \
  --url https://api.microsandbox.dev/v1/quotas \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.microsandbox.dev/v1/quotas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.microsandbox.dev/v1/quotas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.microsandbox.dev/v1/quotas"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.microsandbox.dev/v1/quotas")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "hard_cap": true,
  "memory_gib_hours_used": 123,
  "vcpu_hours_used": 123,
  "concurrent_ephemeral_running": 123,
  "concurrent_persistent_running": 123,
  "is_suspended": true,
  "pool_exhausted": true,
  "total_sandboxes": 123,
  "included_memory_gib_hours": 123,
  "included_vcpu_hours": 123,
  "included_disk_gib_hours": 123,
  "included_storage_gib": 123,
  "max_concurrent_ephemeral_running": 123,
  "max_concurrent_persistent_running": 123,
  "max_disk_size_mib_per_sandbox": 123,
  "max_memory_mib_per_sandbox": 123,
  "max_sandboxes": 123,
  "max_total_storage_gib": 123,
  "max_uptime_minutes_per_sandbox": 123,
  "max_vcpus_per_sandbox": 123
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "unauthorized",
    "details": null
  }
}

{
  "error": {
    "code": "org_not_found",
    "message": "org not found",
    "details": null
  }
}

Authorizations

Authorization

string

header

required

Organization API key (msb_…) - org-scoped programmatic access.

Response

Quota usage

Resolved quota limits and current usage for an organization.

Limits are resolved via COALESCE: per-org override > plan. Every limit is Option: None = unlimited (counts/budgets) or the system/node max (per-sandbox vcpu/memory/disk). There is no magic 0.

hard_cap

boolean

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.

memory_gib_hours_used

number<double>

required

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

vcpu_hours_used

number<double>

required

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

concurrent_ephemeral_running

integer<int64>

required

Currently running/starting ephemeral sandboxes.

concurrent_persistent_running

integer<int64>

required

Currently running/starting persistent sandboxes.

is_suspended

boolean

required

Whether sandbox usage has been manually suspended for the organization.

pool_exhausted

boolean

required

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

total_sandboxes

integer<int64>

required

Total sandboxes (all states) for the org.

included_memory_gib_hours

integer<int32> | null

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

included_vcpu_hours

integer<int32> | null

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

included_disk_gib_hours

integer<int32> | null

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

included_storage_gib

integer<int32> | null

Included durable-storage GiB/month.

max_concurrent_ephemeral_running

integer<int32> | null

Maximum simultaneously-running ephemeral sandboxes.

max_concurrent_persistent_running

integer<int32> | null

Maximum simultaneously-running persistent sandboxes.

max_disk_size_mib_per_sandbox

integer<int32> | null

Maximum writable disk size (MiB) per sandbox.

max_memory_mib_per_sandbox

integer<int32> | null

Maximum memory (MiB) per sandbox.

max_sandboxes

integer<int32> | null

Maximum total sandboxes the org can have.

max_total_storage_gib

integer<int32> | null

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

max_uptime_minutes_per_sandbox

integer<int32> | null

Maximum uptime per sandbox (minutes), if set.

max_vcpus_per_sandbox

integer<int32> | null

Maximum CPU cores per sandbox.

Get a usage summary

⌘I

Get quota usage

curl --request GET \
  --url https://api.microsandbox.dev/v1/quotas \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.microsandbox.dev/v1/quotas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.microsandbox.dev/v1/quotas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.microsandbox.dev/v1/quotas"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.microsandbox.dev/v1/quotas")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "hard_cap": true,
  "memory_gib_hours_used": 123,
  "vcpu_hours_used": 123,
  "concurrent_ephemeral_running": 123,
  "concurrent_persistent_running": 123,
  "is_suspended": true,
  "pool_exhausted": true,
  "total_sandboxes": 123,
  "included_memory_gib_hours": 123,
  "included_vcpu_hours": 123,
  "included_disk_gib_hours": 123,
  "included_storage_gib": 123,
  "max_concurrent_ephemeral_running": 123,
  "max_concurrent_persistent_running": 123,
  "max_disk_size_mib_per_sandbox": 123,
  "max_memory_mib_per_sandbox": 123,
  "max_sandboxes": 123,
  "max_total_storage_gib": 123,
  "max_uptime_minutes_per_sandbox": 123,
  "max_vcpus_per_sandbox": 123
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "unauthorized",
    "details": null
  }
}

{
  "error": {
    "code": "org_not_found",
    "message": "org not found",
    "details": null
  }
}

Getting Started

Sandboxes

Volumes

Quotas

Usage

Audit events

Organization

Members

Authorizations

Response