Stop a session | Vercel REST API

APIs & SDKs

Stop a session

POSThttps://api.vercel.com/v2/sandboxes/sessions/{sessionId}/stop

Stops a running session and releases its allocated resources. All running processes within the session will be terminated. This action cannot be undone. A stopped session cannot be restarted.

https://api.vercel.com/v2/sandboxes/sessions/{sessionId}/stop

const response = await fetch('https://api.vercel.com/v2/sandboxes/sessions/sessionId/stop?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "session": {
    "abortedAt": "1750344501629",
    "activeCpuDurationMs": "42",
    "architecture": "amd64",
    "createdAt": "1750344501629",
    "cwd": "/vercel/sandbox",
    "duration": "3600000",
    "id": "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
    "memory": "2048",
    "networkPolicy": {
      "allowedCIDRs": [],
      "allowedDomains": [],
      "deniedCIDRs": [],
      "injectionRules": [
        {
          "domain": "api.vercel.com",
          "headerNames": []
        }
      ],
      "mode": "custom"
    },
    "networkTransfer": {
      "egress": "123",
      "ingress": "123"
    },
    "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",
    "v0": "false",
    "vcpus": "2"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

sessionIdstringRequired

The unique identifier of the session to stop.

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200The session was stopped successfully.

sessionobjectRequired

This object contains information related to a Vercel Sandbox Session. v2 endpoints return "session" instead of "sandbox" as the response wrapper key.

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

422Error

429Error

500Error

Cross-link map: Stop a session (/docs/rest-api/sandboxes/stop-a-session)

From the Vercel docs graph (built 2026-10-14T10:24:21.026Z), 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

Get a named sandbox — GET /v2/sandboxes/{name} — Retrieves a named sandbox by name, including its current sandbox and routes. If the sandbox i
Fork a named sandbox — POST /v2/sandboxes/{name}/fork — Forks a named sandbox, creating a new named sandbox from the source's configuration. Re
Update a sandbox — PATCH /v2/sandboxes/{name} — Updates the configuration of a sandbox. Only the provided fields will be modified; omitted
Create a named sandbox — POST /v2/sandboxes — Creates a named sandbox environment. Named sandboxes have a unique name within a project and suppor
JS SDK Reference — A comprehensive reference for the Vercel Sandbox JavaScript SDK, which lets you run code in a secure, isolated environme

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/sessions/{sessionId}/stop

const response = await fetch('https://api.vercel.com/v2/sandboxes/sessions/sessionId/stop?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "session": {
    "abortedAt": "1750344501629",
    "activeCpuDurationMs": "42",
    "architecture": "amd64",
    "createdAt": "1750344501629",
    "cwd": "/vercel/sandbox",
    "duration": "3600000",
    "id": "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
    "memory": "2048",
    "networkPolicy": {
      "allowedCIDRs": [],
      "allowedDomains": [],
      "deniedCIDRs": [],
      "injectionRules": [
        {
          "domain": "api.vercel.com",
          "headerNames": []
        }
      ],
      "mode": "custom"
    },
    "networkTransfer": {
      "egress": "123",
      "ingress": "123"
    },
    "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",
    "v0": "false",
    "vcpus": "2"
  }
}

OpenAPI Specification