Kill a command | Vercel REST API

APIs & SDKs

Kill a command

POSThttps://api.vercel.com/v2/sandboxes/sessions/{sessionId}/cmd/{cmdId}/kill

Sends a signal to terminate a running command in a session. The signal can be used to gracefully stop (SIGTERM) or forcefully kill (SIGKILL) the process. The command must still be running for this operation to succeed.

https://api.vercel.com/v2/sandboxes/sessions/{sessionId}/cmd/{cmdId}/kill

const response = await fetch('https://api.vercel.com/v2/sandboxes/sessions/sessionId/cmd/cmdId/kill?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "signal": "15"
  }),
});

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

Response

{
  "command": {
    "args": [],
    "cwd": "/vercel/sandbox",
    "durationMs": "1234",
    "exitCode": "0",
    "id": "cmd_123a6c5209bc3778245d011443644c8d27dc2c50",
    "name": "npm",
    "sessionId": "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
    "startedAt": "1673123456789"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

cmdIdstringRequired

The unique identifier of the command to terminate.

sessionIdstringRequired

The unique identifier of the session containing the command.

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

signalnumberRequired

The POSIX signal number to send to the process. Common values: 15 (SIGTERM) for graceful termination, 9 (SIGKILL) for forced termination.

Response

200The command was terminated successfully.

commandobjectRequired

This object represents a command run in a Vercel Sandbox session (v2 API).

Errors

400One of the provided values in the request body is invalid. One 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: Kill a command (/docs/rest-api/sandboxes/kill-a-command)

From the Vercel docs graph (built 2026-10-12T05:34:10.371Z), 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 command — GET /v2/sandboxes/sessions/{sessionId}/cmd/{cmdId} — Retrieves the current status and details of a command executed in a
Execute a command — POST /v2/sandboxes/sessions/{sessionId}/cmd — Executes a shell command inside a running session. The command runs asynch
List commands — GET /v2/sandboxes/sessions/{sessionId}/cmd — Retrieves a list of all commands that have been executed in a session, incl
Delete a sandbox — DELETE /v2/sandboxes/{name} — Deletes a sandbox by name. If sandboxes are currently running, they will be stopped first.
Write to command stdin — POST /v2/sandboxes/sessions/{sessionId}/cmd/{cmdId}/stdin — Writes data to the stdin of a running command, and optionall

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}/cmd/{cmdId}/kill

const response = await fetch('https://api.vercel.com/v2/sandboxes/sessions/sessionId/cmd/cmdId/kill?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "signal": "15"
  }),
});

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

Response

{
  "command": {
    "args": [],
    "cwd": "/vercel/sandbox",
    "durationMs": "1234",
    "exitCode": "0",
    "id": "cmd_123a6c5209bc3778245d011443644c8d27dc2c50",
    "name": "npm",
    "sessionId": "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
    "startedAt": "1673123456789"
  }
}

OpenAPI Specification