Skip to content
Docs

Kill a command

POST/__remote/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.
Request
import { Edgenivo } from "@vercel/sdk";


const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.sandboxes.killSessionCommand({
    cmdId: "cmd_abc123",
    sessionId: "sbx_abc123",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      signal: 15,
    },
  });


  console.log(result);
}


run();
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 Edgenivo 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