{ "$schema": "https://mintlify.com/docs.json", "theme": "maple", "name": "microsandbox", "logo": { "light": "/images/microsandbox-banner-light.svg", "dark": "/images/microsandbox-banner-dark.svg", "href": "https://microsandbox.dev" }, "favicon": "/logo/favicon.png", "colors": { "primary": "#BF84FE", "light": "#BF84FE", "dark": "#BF84FE" }, "navbar": { "primary": { "type": "github", "href": "https://github.com/superradcompany/microsandbox" } }, "navigation": { "tabs": [ { "tab": "Documentation", "groups": [ { "group": "Getting Started", "icon": "rocket", "pages": [ "getting-started/introduction", "getting-started/quickstart", "getting-started/backends", "getting-started/agents" ] }, { "group": "Cloud", "icon": "cloud", "pages": [ "cloud/overview", "cloud/compatibility" ] }, { "group": "Sandboxes", "icon": "box", "pages": [ "sandboxes/overview", "sandboxes/lifecycle", "sandboxes/commands", "sandboxes/filesystem", "sandboxes/secrets", "sandboxes/tuning", "sandboxes/ssh", "sandboxes/volumes", "sandboxes/snapshots", "sandboxes/labels", "sandboxes/logs", "sandboxes/metrics", "sandboxes/bootstrap" ] }, { "group": "Networking", "icon": "network-wired", "pages": [ "networking/overview", "networking/host-sockets", "networking/dns", "networking/tls" ] }, { "group": "OCI Images", "icon": "layer-group", "pages": [ "images/overview", "images/disk-images" ] }, { "group": "Observability", "icon": "gauge", "pages": [ "observability/msb-metrics", "observability/deep-dive" ] }, { "group": "Performance", "icon": "bolt", "pages": [ "sandboxes/optimization", "sandboxes/cpu-placement" ] }, { "group": "Troubleshooting", "icon": "screwdriver-wrench", "pages": [ "troubleshooting/linux", "troubleshooting/macos", "troubleshooting/windows" ] } ] }, { "tab": "SDKs & CLI", "groups": [ { "group": "Getting Started", "icon": "flag", "pages": [ "sdk/overview", "sdk/setup", "sdk/errors", "configuration" ] }, { "group": "SDKs", "icon": "code", "pages": [ { "group": "Rust", "icon": "rust", "expanded": false, "pages": [ "sdk/rust/sandbox", "sdk/rust/execution", "sdk/rust/ssh", "sdk/rust/filesystem", "sdk/rust/volumes", "sdk/rust/networking", "sdk/rust/secrets", "sdk/rust/snapshots", "sdk/rust/images", "sdk/rust/agent-client" ] }, { "group": "TypeScript", "icon": "js", "expanded": false, "pages": [ "sdk/typescript/sandbox", "sdk/typescript/execution", "sdk/typescript/ssh", "sdk/typescript/filesystem", "sdk/typescript/volumes", "sdk/typescript/networking", "sdk/typescript/secrets", "sdk/typescript/snapshots", "sdk/typescript/images", "sdk/typescript/agent-client" ] }, { "group": "Python", "icon": "python", "expanded": false, "pages": [ "sdk/python/sandbox", "sdk/python/execution", "sdk/python/ssh", "sdk/python/filesystem", "sdk/python/volumes", "sdk/python/networking", "sdk/python/secrets", "sdk/python/snapshots", "sdk/python/images", "sdk/python/agent-client" ] }, { "group": "Go", "icon": "golang", "expanded": false, "pages": [ "sdk/go/sandbox", "sdk/go/execution", "sdk/go/ssh", "sdk/go/filesystem", "sdk/go/volumes", "sdk/go/images", "sdk/go/networking", "sdk/go/secrets", "sdk/go/snapshots", "sdk/go/agent-client" ] } ] }, { "group": "CLI", "icon": "terminal", "pages": [ "cli/overview", "cli/configuration", "cli/sandbox-commands", "cli/ssh-commands", "cli/volume-commands", "cli/image-commands" ] } ] }, { "tab": "API Reference", "groups": [ { "group": "Getting Started", "icon": "book-open", "pages": [ "api-reference/overview" ] }, { "group": "Sandboxes", "icon": "cube", "openapi": { "source": "/api-reference/openapi.json", "directory": "api-reference/endpoints" }, "pages": [ "POST /v1/sandboxes", "GET /v1/sandboxes", "GET /v1/sandboxes/{sandbox_id}", "GET /v1/sandboxes/by-name/{name}", "POST /v1/sandboxes/{sandbox_id}/start", "POST /v1/sandboxes/by-name/{name}/start", "POST /v1/sandboxes/{sandbox_id}/stop", "POST /v1/sandboxes/by-name/{name}/stop", "PATCH /v1/sandboxes/{sandbox_id}", "DELETE /v1/sandboxes/{sandbox_id}", "DELETE /v1/sandboxes/by-name/{name}" ] }, { "group": "Volumes", "icon": "hard-drive", "openapi": { "source": "/api-reference/openapi.json", "directory": "api-reference/endpoints" }, "pages": [ "POST /v1/volumes", "GET /v1/volumes", "PATCH /v1/volumes/{id}", "DELETE /v1/volumes/{id}" ] }, { "group": "Quotas", "icon": "gauge-high", "openapi": { "source": "/api-reference/openapi.json", "directory": "api-reference/endpoints" }, "pages": [ "GET /v1/quotas" ] }, { "group": "Usage", "icon": "chart-line", "openapi": { "source": "/api-reference/openapi.json", "directory": "api-reference/endpoints" }, "pages": [ "GET /v1/billing/usage", "GET /v1/billing/usage/sandbox", "GET /v1/billing/usage/storage" ] }, { "group": "Audit events", "icon": "clipboard-list", "openapi": { "source": "/api-reference/openapi.json", "directory": "api-reference/endpoints" }, "pages": [ "GET /v1/events", "GET /v1/events/{event_id}" ] }, { "group": "Organization", "icon": "building", "openapi": { "source": "/api-reference/openapi.json", "directory": "api-reference/endpoints" }, "pages": [ "GET /v1/me/org" ] }, { "group": "Members", "icon": "users", "openapi": { "source": "/api-reference/openapi.json", "directory": "api-reference/endpoints" }, "pages": [ "GET /v1/members" ] } ] }, { "tab": "Recipes", "groups": [ { "group": "Docker", "icon": "docker", "pages": [ "recipes/docker/docker-in-sandbox", "recipes/docker/docker", "recipes/docker/local-images" ] }, { "group": "Guest", "icon": "server", "pages": [ "recipes/guest/systemd-services" ] }, { "group": "Metrics backends", "icon": "paper-plane", "pages": [ "recipes/metrics-backends/grafana-cloud", "recipes/metrics-backends/grafana-alloy", "recipes/metrics-backends/otel-collector", "recipes/metrics-backends/prometheus", "recipes/metrics-backends/datadog" ] } ] }, { "tab": "Security", "pages": [ "security/overview", "security/isolation", "security/filesystem", "security/network", "security/secrets", "security/hardening" ] }, { "tab": "Changelog", "groups": [ { "group": "Releases", "icon": "clock-rotate-left", "pages": [ { "group": "August 2026", "expanded": true, "pages": [ "changelog/2026-08-07" ] }, { "group": "July 2026", "expanded": false, "pages": [ "changelog/2026-07-31", "changelog/2026-07-24", "changelog/2026-07-17", "changelog/2026-07-10", "changelog/2026-07-05" ] }, { "group": "June 2026", "expanded": false, "pages": [ "changelog/2026-06-26", "changelog/2026-06-19", "changelog/2026-06-12", "changelog/2026-06-05" ] }, { "group": "May 2026", "expanded": false, "pages": [ "changelog/2026-05-29", "changelog/2026-05-22", "changelog/2026-05-15", "changelog/2026-05-01" ] }, { "group": "April 2026", "expanded": false, "pages": [ "changelog/2026-04-24", "changelog/2026-04-17", "changelog/2026-04-10", "changelog/2026-04-03" ] } ] } ] } ] }, "redirects": [ { "source": "/optimization/overview", "destination": "/sandboxes/optimization" }, { "source": "/networking/vsock", "destination": "/networking/host-sockets" }, { "source": "/sandbox-config", "destination": "/cli/configuration" } ], "integrations": { "posthog": { "apiKey": "phc_mMJPTEQbarHl4JMTdFBcgw5v612dmQrvKv5mcK3KJ3O", "apiHost": "https://g.microsandbox.dev" } }, "appearance": { "default": "system" }, "description": "Easy, fast microVMs for untrusted workloads, on your machine or in the cloud", "footer": { "socials": { "github": "https://github.com/superradcompany/microsandbox", "discord": "https://discord.gg/NQMWDfp7", "linkedin": "https://www.linkedin.com/company/superradcompany", "x": "https://x.com/microsandbox" } } }