sandboxes

Get a session

Changed on

Retrieves detailed information about a specific session, including its current status, resource configuration, and exposed routes.

get/v2/sandboxes/sessions/{sessionId}

Request

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

Path parameters

sessionIdstring required

The unique identifier of the session to retrieve.

Example:sbx_abc123

Query parameters

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 session was retrieved successfully.

Example response

{
  "session": {
    "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