---
title: list-sandboxes
product: vercel
url: /docs/rest-api/sandboxes-v2-beta/list-sandboxes
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about list-sandboxes on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# List sandboxes

```http
GET /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.

## Authentication

**bearerToken**: HTTP bearer

## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `project` | string | No | The unique identifier or name of the project to list named sandboxes for. |
| `limit` | number. min: 1; max: 50; default: 20 | No | Maximum number of named sandboxes to return in the response. Used for pagination. |
| `sortBy` | string. enum: createdAt, name, statusUpdatedAt; default: "createdAt" | No | Field to sort by. |
| `namePrefix` | string | No | Filter named sandboxes whose name starts with this prefix. Only valid when sortBy=name. |
| `cursor` | string | No | Opaque pagination cursor from a previous response. |
| `sortOrder` | string. enum: asc, desc; default: "desc" | No | Sort direction. Defaults to desc. |
| `tags` | object | No | Filter sandboxes by tag. Format: \"key:value\". Only one tag filter is supported at a time. |
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "pagination",
    "sandboxes"
  ],
  "properties": {
    "sandboxes": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "This object contains information related to a Vercel NamedSandbox.",
        "required": [
          "createdAt",
          "currentSessionId",
          "name",
          "persistent",
          "status",
          "statusUpdatedAt",
          "updatedAt"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The unique identifier of the sandbox."
          },
          "currentSnapshotId": {
            "type": "string",
            "description": "Current snapshot ID that the named sandbox is pointing to."
          },
          "currentSessionId": {
            "type": "string",
            "description": "Current session ID the sandbox is pointing to."
          },
          "status": {
            "type": "string",
            "description": "The status of the current sandbox.",
            "enum": [
              "stopping",
              "running",
              "stopped"
            ]
          },
          "statusUpdatedAt": {
            "type": "number",
            "description": "The time when the sandbox status was last updated, in milliseconds since the epoch."
          },
          "persistent": {
            "type": "boolean",
            "description": "Whether the sandbox persists its state across restarts via automatic snapshots.",
            "enum": [
              false,
              true
            ]
          },
          "region": {
            "type": "string",
            "description": "The region the sandbox runs in."
          },
          "vcpus": {
            "type": "number",
            "description": "Number of virtual CPUs allocated."
          },
          "memory": {
            "type": "number",
            "description": "Memory allocated in MB."
          },
          "runtime": {
            "type": "string",
            "description": "Runtime identifier."
          },
          "timeout": {
            "type": "number",
            "description": "Timeout in milliseconds."
          },
          "snapshotExpiration": {
            "type": "number",
            "description": "Default snapshot expiration time in milliseconds. 0 means no expiration."
          },
          "networkPolicy": {
            "type": "object",
            "description": "Network policy configuration.",
            "required": [
              "mode"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "allow-all",
                  "deny-all",
                  "custom",
                  "default-allow",
                  "default-deny"
                ]
              },
              "allowedDomains": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "allowedCIDRs": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "deniedCIDRs": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "totalEgressBytes": {
            "type": "number",
            "description": "Cumulative egress bytes across all sandbox runs."
          },
          "totalIngressBytes": {
            "type": "number",
            "description": "Cumulative ingress bytes across all sandbox runs."
          },
          "totalActiveCpuDurationMs": {
            "type": "number",
            "description": "Cumulative active CPU duration in milliseconds across all sandbox runs."
          },
          "totalDurationMs": {
            "type": "number",
            "description": "Cumulative wall-clock duration in milliseconds across all sandbox runs."
          },
          "cwd": {
            "type": "string",
            "description": "The working directory of the sandbox."
          },
          "tags": {
            "type": "object",
            "description": "Key-value tags attached to the named sandbox.",
            "additionalProperties": {
              "type": "string"
            }
          },
          "createdAt": {
            "type": "number",
            "description": "The time when the named sandbox was created, in milliseconds since the epoch."
          },
          "updatedAt": {
            "type": "number",
            "description": "The time when the named sandbox was last updated, in milliseconds since the epoch."
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "required": [
        "count",
        "next"
      ],
      "properties": {
        "count": {
          "type": "number"
        },
        "next": {
          "type": "string",
          "nullable": true
        }
      }
    }
  }
}
```

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

### 401: The request is not authorized.

### 403: You do not have permission to access this resource.

### 404: No description

---

## Related

- [sandboxes-v2-beta endpoints](/docs/rest-api#sandboxes-v2-beta)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)