sandboxes

Delete a sandbox

Changed on

Deletes a sandbox by name. If sandboxes are currently running, they will be stopped first. This operation deletes all sandbox entities with the given name and the named sandbox metadata. When the config item is already missing, the returned sandbox uses stored metadata and defaults; config fields may be stale.

delete/v2/sandboxes/{name}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v2/sandboxes/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

The sandbox name to delete.

Example:my-sandbox

Query parameters

projectIdstring

The project ID that owns the named sandbox. When provided, takes precedence over OIDC project context.

deleteOrphanSnapshotsboolean

When true, snapshots of the deleted sandbox that are not referenced by any other sandbox are also deleted asynchronously. Defaults to false.

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Example response

{
  "sandbox": {
    "createdAt": 1750344501629,
    "cwd": "/vercel/sandbox",
    "expiresAt": 1750344801629,
    "failoverRegions": [
      "sfo1",
      "cle1"
    ],
    "image": "my-team/my-project/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
  }
}

Changes