Snapshot

This object contains information related to a Snapshot of a Vercel Sandbox session (v2 API).

Example Usage

import { Snapshot } from "@vercel/sdk/models/snapshot.js";

let value: Snapshot = {
  createdAt: 1750344501629,
  creationMethod: "manual",
  expiresAt: 1750344501629,
  id: "snap_123a6c5209bc3778245d011443644c8d27dc2c50",
  lastUsedAt: 1750344501629,
  parentId: "snap_parent123",
  region: "iad1",
  regions: [
    "iad1",
    "sfo1",
  ],
  sizeBytes: 104857600,
  sourceSessionId: "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
  status: "created",
  updatedAt: 1750344501629,
};

Fields

Field	Type	Required	Description	Example
createdAt	number	:heavy_check_mark:	The time when the snapshot was created, in milliseconds since the epoch.	1750344501629
creationMethod	models.CreationMethod	:heavy_minus_sign:	The method used to create the snapshot.	manual
expiresAt	number	:heavy_minus_sign:	The time when the snapshot will expire, in milliseconds since the epoch. If not set, the snapshot does not have any expiration.	1750344501629
id	string	:heavy_check_mark:	The unique identifier of the snapshot.	snap_123a6c5209bc3778245d011443644c8d27dc2c50
lastUsedAt	number	:heavy_check_mark:	The last time the snapshot was used (e.g. to resume or create a sandbox), in milliseconds since the epoch. Falls back to createdAt for older snapshots that predate this field.	1750344501629
parentId	string	:heavy_minus_sign:	The unique identifier of the parent snapshot, if this snapshot was created from another snapshot.	snap_parent123
region	string	:heavy_minus_sign:	The region where the snapshot is stored.	iad1
regions	string[]	:heavy_minus_sign:	The regions where the snapshot is available.	[ "iad1", "sfo1" ]
sizeBytes	number	:heavy_check_mark:	The size of the snapshot in bytes.	104857600
sourceSessionId	string	:heavy_check_mark:	The unique identifier of the session from which the snapshot was created.	sbx_123a6c5209bc3778245d011443644c8d27dc2c50
status	models.SnapshotStatus	:heavy_check_mark:	The status of the snapshot.	created
updatedAt	number	:heavy_check_mark:	The last time the snapshot was updated, in milliseconds since the epoch.	1750344501629