--- title: "Get a session" method: GET path: "/v2/sandboxes/sessions/{sessionId}" tags: ["sandboxes"] --- # Get a session `GET /v2/sandboxes/sessions/{sessionId}` ## Request - Base URL: `https://api.vercel.com` - URL: `https://api.vercel.com/v2/sandboxes/sessions/{sessionId}` - Auth: HTTP bearer Retrieves detailed information about a specific session, including its current status, resource configuration, and exposed routes. ## Path parameters - `sessionId` string, required: The unique identifier of the session to retrieve. ## Query parameters - `teamId` string - `slug` string ## Response `200` The session was retrieved successfully. - object - `routes` SandboxPublicRoute[], required - `port` number, required: The user port number that the route is mapped to. - `subdomain` string, required: The subdomain assigned to this route. - `system` true: Whether the route is reserved by the system (e.g. for internal use). - `url` string, required: A public URL to access the corresponding port in the Sandbox. - `session` Session, required: This object contains information related to a Vercel Sandbox Session. v2 endpoints return "session" instead of "sandbox" as the response wrapper key. - `abortedAt` number: The time when the sandbox was aborted, in milliseconds since the epoch. - `activeCpuDurationMs` number: The amount of CPU time the sandbox consumed, if available, in milliseconds. This value is only available once the sandbox is stopped, and only if it stopped successfully. - `architecture` 'amd64' | 'arm64': CPU architecture of the sandbox. - `createdAt` number, required: The time when the sandbox was created, in milliseconds since the epoch. - `cwd` string, required: The working directory of the sandbox. - `duration` number: The duration of the sandbox in milliseconds. - `id` string, required: The unique identifier of the sandbox. - `memory` number, required: Memory allocated to this sandbox in MB. - `networkPolicy` SandboxNetworkPolicy: The network policy applied to this sandbox, if any. - `allowedCIDRs` string[]: List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. - `allowedDomains` string[]: List of domain names the sandbox is allowed to connect to. Supports wildcard patterns (e.g., "*.vercel.com" matches all subdomains). - `deniedCIDRs` string[]: List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. - `injectionRules` SandboxInjectionRule[]: HTTP header injection rules for outgoing requests matching specific domains. - `domain` string, required: The domain (or pattern) that this injection rule applies to. Supports wildcards like *.vercel.com. - `headerNames` string[]: The names of HTTP headers that have value that will be injected for requests to this domain. - `mode` 'allow-all' | 'custom' | 'deny-all', required: The network policy mode. - 'allow-all': All traffic is allowed. - 'deny-all': All traffic is blocked. - 'custom': Traffic is controlled by explicit allow/deny rules. - `networkTransfer` object: The quantity of data transfered to and from the sandbox, in bytes. This value is only available once the sandbox is stopped, and only if it stopped successfully. - `egress` number, required - `ingress` number, required - `projectId` string, required: The unique identifier of the project associated with this session. - `region` string, required: The region where the sandbox is hosted. - `requestedAt` number, required: The time when the sandbox was requested, in milliseconds since the epoch. - `requestedStopAt` number: The time when the sandbox was requested to stop, in milliseconds since the epoch. - `runtime` string, required: The runtime of the sandbox. - `snapshottedAt` number: The time when a snapshot was requested, in milliseconds since the epoch. - `sourceSandboxName` string, required: The name of the source sandbox. - `sourceSnapshotId` string: The unique identifier of the snapshot associated with this sandbox, if any. - `startedAt` number: The time when the sandbox was started, in milliseconds since the epoch. - `status` 'aborted' | 'failed' | 'pending' | 'running' | 'snapshotting' | 'stopped' | 'stopping', required: The status of the sandbox. - `stoppedAt` number: The time when the sandbox was stopped, in milliseconds since the epoch. - `timeout` number, required: The maximum amount of time the sandbox will run for in milliseconds. - `updatedAt` number, required: The last time the sandbox was updated, in milliseconds since the epoch. - `vcpus` number, required: Number of vCPUs allocated to this sandbox. - `workloadType` 'sandbox' | 'v0': The workload type of this sandbox. ## Other responses - `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` - `410` - `422` - `429` - `500` ## Changes - **2026-10-26** `01d3fe4ea5c3`: 1 warning, 1 info - removed the optional property `session/v0` from the response with the `200` status - added the optional property `session/workloadType` to the response with the `200` status - **2026-10-24** `4a06e85c2848`: 1 info - added the non-success response with the status `422` - **2026-10-01** `9958fd10bb05`: 1 info - added the optional property `session/v0` to the response with the `200` status - **2026-09-18** `c32b8afee578`: 1 info - added the optional property `session/architecture` to the response with the `200` status - **2026-07-21** `2ae10ee9d21c`: 1 info - added the non-success response with the status `410` [Operation history](https://skmtc.dev/vercel/apis/vercel-api/changes/v2/sandboxes/sessions/:sessionId/get.md) --- [API](https://skmtc.dev/vercel/apis/vercel-api.md) - [All operations](https://skmtc.dev/vercel/apis/vercel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vercel/apis/vercel-api/revisions/60686c0e1f6a?raw)