List sandboxes | Vercel REST API

APIs & SDKs

List sandboxes

GEThttps://api.vercel.com/v2/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.

https://api.vercel.com/v2/sandboxes

const response = await fetch('https://api.vercel.com/v2/sandboxes?project=string&limit=123&sortBy=string&namePrefix=string&cursor=string&sortOrder=string&status=string&tags=value&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "pagination": {
    "count": "123",
    "next": "string"
  },
  "sandboxes": [
    {
      "architecture": "amd64",
      "createdAt": "1750344501629",
      "currentSessionId": "example_id",
      "currentSnapshotId": "example_id",
      "cwd": "/vercel/sandbox",
      "expiresAt": "1750344801629",
      "failoverRegions": [],
      "image": "my-team/my-project/my-repo@sha256:2c4e8f9a1b3d5e7f091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708",
      "keepLastSnapshots": {
        "count": "5",
        "deleteEvicted": "true",
        "expiration": "604800000"
      },
      "memory": "1024",
      "mounts": "value",
      "name": "my-sandbox",
      "networkId": "example_id",
      "networkPolicy": {
        "allowedCIDRs": [],
        "allowedDomains": [],
        "deniedCIDRs": [],
        "mode": "allow-all",
        "s3Key": "string"
      },
      "persistent": "true",
      "region": "iad1",
      "runtime": "node22",
      "snapshotExpiration": "604800000",
      "status": "running",
      "statusUpdatedAt": "1750344501629",
      "tags": "[object Object]",
      "timeout": "300000",
      "totalActiveCpuDurationMs": "5000",
      "totalDurationMs": "60000",
      "totalEgressBytes": "4096",
      "totalIngressBytes": "2048",
      "updatedAt": "1750344501629",
      "v0": "false",
      "vcpus": "2"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectstringOptional

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

limitnumberOptional

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

sortBystringOptional

Field to sort by.

namePrefixstringOptional

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

cursorstringOptional

Opaque pagination cursor from a previous response.

sortOrderstringOptional

Sort direction. Defaults to desc.

statusstringOptional

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

tagsanyOptional

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

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

paginationobjectRequired

sandboxesarrayRequired

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

429Error

Cross-link map: List sandboxes (/docs/rest-api/sandboxes/list-sandboxes)

From the Vercel docs graph (built 2026-10-12T05:34:10.371Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Delete a sandbox — DELETE /v2/sandboxes/{name} — Deletes a sandbox by name. If sandboxes are currently running, they will be stopped first.
Get a session — GET /v2/sandboxes/sessions/{sessionId} — Retrieves detailed information about a specific session, including its current
List sessions — GET /v2/sandboxes/sessions — Retrieves a paginated list of sessions belonging to a specific sandbox. Results are sorted
List snapshots — GET /v2/sandboxes/snapshots — Retrieves a paginated list of snapshots for a specific project.
Create a snapshot — POST /v2/sandboxes/sessions/{sessionId}/snapshot — Creates a point-in-time snapshot of a running session's filesystem. S

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v2/sandboxes

const response = await fetch('https://api.vercel.com/v2/sandboxes?project=string&limit=123&sortBy=string&namePrefix=string&cursor=string&sortOrder=string&status=string&tags=value&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "pagination": {
    "count": "123",
    "next": "string"
  },
  "sandboxes": [
    {
      "architecture": "amd64",
      "createdAt": "1750344501629",
      "currentSessionId": "example_id",
      "currentSnapshotId": "example_id",
      "cwd": "/vercel/sandbox",
      "expiresAt": "1750344801629",
      "failoverRegions": [],
      "image": "my-team/my-project/my-repo@sha256:2c4e8f9a1b3d5e7f091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708",
      "keepLastSnapshots": {
        "count": "5",
        "deleteEvicted": "true",
        "expiration": "604800000"
      },
      "memory": "1024",
      "mounts": "value",
      "name": "my-sandbox",
      "networkId": "example_id",
      "networkPolicy": {
        "allowedCIDRs": [],
        "allowedDomains": [],
        "deniedCIDRs": [],
        "mode": "allow-all",
        "s3Key": "string"
      },
      "persistent": "true",
      "region": "iad1",
      "runtime": "node22",
      "snapshotExpiration": "604800000",
      "status": "running",
      "statusUpdatedAt": "1750344501629",
      "tags": "[object Object]",
      "timeout": "300000",
      "totalActiveCpuDurationMs": "5000",
      "totalDurationMs": "60000",
      "totalEgressBytes": "4096",
      "totalIngressBytes": "2048",
      "updatedAt": "1750344501629",
      "v0": "false",
      "vcpus": "2"
    }
  ]
}

OpenAPI Specification