NamedSandbox

This object contains information related to a Vercel NamedSandbox.

Example Usage

import { NamedSandbox } from "@vercel/sdk/models/namedsandbox.js";

let value: NamedSandbox = {
  createdAt: 1750344501629,
  currentSessionId: "<id>",
  cwd: "/vercel/sandbox",
  expiresAt: 1750344801629,
  failoverRegions: [
    "sfo1",
    "cle1",
  ],
  image:
    "my-repo@sha256:2c4e8f9a1b3d5e7f091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708",
  keepLastSnapshots: {
    count: 5,
    deleteEvicted: true,
    expiration: 604800000,
  },
  memory: 1024,
  name: "my-sandbox",
  persistent: true,
  region: "iad1",
  runtime: "node22",
  snapshotExpiration: 604800000,
  status: "running",
  statusUpdatedAt: 1750344501629,
  tags: {
    "team": "hive",
    "user": "bob",
  },
  timeout: 300000,
  totalActiveCpuDurationMs: 5000,
  totalDurationMs: 60000,
  totalEgressBytes: 4096,
  totalIngressBytes: 2048,
  updatedAt: 1750344501629,
  vcpus: 2,
};

Fields

Field	Type	Required	Description	Example
createdAt	number	:heavy_check_mark:	The time when the named sandbox was created, in milliseconds since the epoch.	1750344501629
currentSessionId	string	:heavy_check_mark:	Current session ID the sandbox is pointing to.
currentSnapshotId	string	:heavy_minus_sign:	Current snapshot ID that the named sandbox is pointing to.
cwd	string	:heavy_minus_sign:	The working directory of the sandbox.	/vercel/sandbox
expiresAt	number	:heavy_minus_sign:	The time at which the currently running sandbox will time out, in milliseconds since the epoch. Only present while a session is running.	1750344801629
failoverRegions	models.FailoverRegions[]	:heavy_minus_sign:	The regions the sandbox fails over to. Empty when it does not fail over.	[ "sfo1", "cle1" ]
image	string	:heavy_minus_sign:	Digest-pinned reference of the container image the sandbox was created from, when it was created from an image ("{repository}@{manifestDigest}").	my-repo@sha256:2c4e8f9a1b3d5e7f091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708
keepLastSnapshots	models.KeepLastSnapshots	:heavy_minus_sign:	Keep-last snapshot configuration.
memory	number	:heavy_minus_sign:	Memory allocated in MB.	1024
mounts	Record<string, models.Mounts>	:heavy_minus_sign:	Key-value pairs of mount path and drive.
name	string	:heavy_check_mark:	The unique identifier of the sandbox.	my-sandbox
networkId	string	:heavy_minus_sign:	The Connect network id for the target Secure Compute private network.
networkPolicy	models.NetworkPolicy	:heavy_minus_sign:	Network policy configuration.
persistent	boolean	:heavy_check_mark:	Whether the sandbox persists its state across restarts via automatic snapshots.	true
region	string	:heavy_minus_sign:	The region the sandbox is pinned to: the region stored on the sandbox, otherwise the platform default. Where a running session actually landed is reported by session.region.	iad1
runtime	string	:heavy_minus_sign:	Runtime identifier.	node22
snapshotExpiration	number	:heavy_minus_sign:	Default snapshot expiration time in milliseconds. 0 means no expiration.	604800000
status	models.NamedSandboxStatus	:heavy_check_mark:	The status of the current sandbox.	running
statusUpdatedAt	number	:heavy_check_mark:	The time when the sandbox status was last updated, in milliseconds since the epoch.	1750344501629
tags	Record<string, string>	:heavy_minus_sign:	Key-value tags attached to the named sandbox.	{ "team": "hive", "user": "bob" }
timeout	number	:heavy_minus_sign:	Timeout in milliseconds.	300000
totalActiveCpuDurationMs	number	:heavy_minus_sign:	Cumulative active CPU duration in milliseconds across all sandbox runs.	5000
totalDurationMs	number	:heavy_minus_sign:	Cumulative wall-clock duration in milliseconds across all sandbox runs.	60000
totalEgressBytes	number	:heavy_minus_sign:	Cumulative egress bytes across all sandbox runs.	4096
totalIngressBytes	number	:heavy_minus_sign:	Cumulative ingress bytes across all sandbox runs.	2048
updatedAt	number	:heavy_check_mark:	The time when the named sandbox was last updated, in milliseconds since the epoch.	1750344501629
vcpus	number	:heavy_minus_sign:	Number of virtual CPUs allocated.	2