Create a Sandbox

The Sandbox.create() static method is the primary entry point for provisioning an isolated Linux microVM on the Deploy edge. It returns a connected Sandbox instance that you can use to run commands, upload files, expose HTTP endpoints, or request SSH access.

import { Sandbox } from "@deno/sandbox";

await using sandbox = await Sandbox.create();

By default, this creates an ephemeral sandbox in the closest Deploy region with 768 MB of RAM, no outbound network access, and a lifetime bound to the current process. You can tailor the sandbox by passing an options object.

Available options Jump to heading#

Example configurations Jump to heading#

Run in a specific region with more memory Jump to heading#

const sandbox = await Sandbox.create({
  region: "ams",
  memoryMb: 2048,
});

Keep the sandbox alive for later inspection Jump to heading#

const sandbox = await Sandbox.create({ lifetime: "10m" });
const id = sandbox.id;
await sandbox.close(); // disconnect but leave VM running

// ...later...
const reconnected = await Sandbox.connect({ id });

Provide default environment variables Jump to heading#

const sandbox = await Sandbox.create({
  env: {
    NODE_ENV: "development",
    FEATURE_FLAG: "agents",
  },
});

Tips Jump to heading#

• Use metadata keys such as agentId or customerId to trace sandboxes in the Deploy dashboard.
• Let await using (or dropping the last reference) dispose of the sandbox automatically. Call sandbox.kill() only when you need to terminate it prior to that automatic cleanup.
• For long-lived services, migrate from sandboxes to a Deploy app once the code stabilizes.