VEvercel
sandboxes

List sessions

Changed on

Retrieves a paginated list of sessions belonging to a specific sandbox. Results are sorted by creation time and paginated using an opaque cursor.

get/v2/sandboxes/sessions

Request

  • Base URL
    https://api.vercel.com
  • URL
    https://api.vercel.com/v2/sandboxes/sessions
  • Auth
    HTTP bearer

Query parameters

projectstring

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

Example:prj_abc123
namestring

Filter sessions by sandbox name. Only sessions belonging to the specified sandbox are returned.

Example:my-sandbox
limitnumber

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

Example:20
cursorstring

Opaque pagination cursor from a previous response.

sortOrder'asc' | 'desc'

Sort direction for results by creation 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

The list of sessions matching the request filters.

object required
OR

Example response

{
  "sessions": [
    {
      "abortedAt": 1750344501629,
      "activeCpuDurationMs": 42,
      "createdAt": 1750344501629,
      "cwd": "/vercel/sandbox",
      "duration": 3600000,
      "id": "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
      "memory": 2048,
      "networkPolicy": {
        "allowedCIDRs": [
          "10.0.0.0/8"
        ],
        "allowedDomains": [
          "api.vercel.com",
          "*.example.com"
        ],
        "deniedCIDRs": [
          "10.0.0.0/8"
        ],
        "injectionRules": [
          {
            "domain": "api.vercel.com",
            "headerNames": [
              "Authorization",
              "X-API-Key"
            ]
          }
        ],
        "mode": "custom"
      },
      "networkTransfer": {
        "in": 12543852,
        "out": 15368
      },
      "projectId": "prj_123a6c5209bc3778245d011443644c8d27dc2c50",
      "region": "iad1",
      "requestedAt": 1750344501629,
      "requestedStopAt": 1750344501629,
      "runtime": "node22",
      "snapshottedAt": 1750344501629,
      "sourceSandboxName": "my-sandbox",
      "sourceSnapshotId": "snap_123a6c5209bc3778245d011443644c8d27dc2c50",
      "startedAt": 1750344501629,
      "status": "running",
      "stoppedAt": 1750344501629,
      "timeout": 3600000,
      "updatedAt": 1750344501629,
      "vcpus": 2
    }
  ]
}

Changes

  • 01d3fe4ea5c3Revision changes
    • warning

      removed the optional property /// from the response with the status

    • info

      added the optional property /// to the response with the status

  • 4a06e85c2848Revision changes
    • info

      added the non-success response with the status