Sign in

v14

latestOpenAPI 3.0.32026-08-04377889.4 MB
sandboxes

List sandboxes

Retrieves a paginated list of named sandboxes belonging to a specific project. Results can be sorted by creation time or name, and optionally filtered by name prefix or status.

get/v2/sandboxes

Query parameters

projectstring

The unique identifier or name of the project to list named sandboxes for.

Example:prj_abc123

The unique identifier or name of the project to list named sandboxes for.

limitnumber

Maximum number of named sandboxes to return in the response. Used for pagination.

Example:20

Maximum number of named sandboxes to return in the response. Used for pagination.

sortBy'createdAt' | 'name' | 'statusUpdatedAt' | 'currentSnapshotId'

Field to sort by.

Field to sort by.

namePrefixstring

Filter named sandboxes whose name starts with this prefix. Only valid when sortBy=name.

Filter named sandboxes whose name starts with this prefix. Only valid when sortBy=name.

cursorstring

Opaque pagination cursor from a previous response.

Opaque pagination cursor from a previous response.

sortOrder'asc' | 'desc'

Sort direction. Defaults to desc.

Sort direction. Defaults to desc.

status'running' | 'stopping' | 'stopped'

Filter named sandboxes by status. Only valid when sortBy is createdAt.

Filter named sandboxes by status. Only valid when sortBy is createdAt.

string
OR
string[]

Filter sandboxes by tag. Format: "key:value". Only one tag filter is supported at a time.

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

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