Kill Process

curl --request POST \
  --url https://api.example.com/api/connections/kill \
  --header 'Content-Type: application/json' \
  --data '{
  "pid": 123
}'

import requests

url = "https://api.example.com/api/connections/kill"

payload = { "pid": 123 }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({pid: 123})
};

fetch('https://api.example.com/api/connections/kill', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/connections/kill",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pid' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/connections/kill"

	payload := strings.NewReader("{\n  \"pid\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/connections/kill")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pid\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "error": "<string>"
}

POST

api

connections

kill

Kill Process

curl --request POST \
  --url https://api.example.com/api/connections/kill \
  --header 'Content-Type: application/json' \
  --data '{
  "pid": 123
}'

import requests

url = "https://api.example.com/api/connections/kill"

payload = { "pid": 123 }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({pid: 123})
};

fetch('https://api.example.com/api/connections/kill', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/connections/kill",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pid' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/connections/kill"

	payload := strings.NewReader("{\n  \"pid\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/connections/kill")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pid\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "error": "<string>"
}

Endpoint

POST /api/connections/kill

Sends a SIGTERM signal to terminate a process by its PID. This endpoint provides a safe way to stop processes from the psys interface.

Request

number

required

The process ID (PID) of the process to terminate. Must be a positive integer.

Example Request

curl -X POST http://localhost:3000/api/connections/kill \
  -H "Content-Type: application/json" \
  -d '{"pid": 1234}'

fetch('/api/connections/kill', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ pid: 1234 })
})

Response

Success Response (200)

Returned when the process is successfully terminated.

boolean

required

Always true on success

{
  "ok": true
}

Error Responses

string

Error message describing what went wrong

400 Bad Request

Returned when the PID is invalid (not a number, negative, or zero).

{
  "error": "Invalid pid"
}

Causes:

PID is not a number
PID is less than or equal to 0
PID is not an integer

403 Forbidden

Returned when the process cannot be killed due to insufficient permissions (EPERM error).

{
  "error": "Permission denied"
}

Causes:

Process is owned by another user
Process requires elevated privileges to terminate
System security policies prevent the operation

404 Not Found

Returned when the specified process does not exist (ESRCH error).

{
  "error": "Process not found"
}

Causes:

Process with the given PID does not exist
Process has already terminated

500 Internal Server Error

Returned for any other unexpected error during process termination.

{
  "error": "Failed to kill process"
}

Implementation Details

Uses Node.js process.kill(pid, 'SIGTERM') to send the termination signal
SIGTERM allows the process to perform cleanup before exiting
The endpoint is configured with dynamic = "force-dynamic" and runtime = "nodejs"
PID validation accepts both numeric values and string representations that can be parsed as integers

Important: This endpoint sends SIGTERM, which allows graceful shutdown. The process may take time to terminate or may ignore the signal. Use system tools like kill -9 for forced termination if needed.

Security Considerations

Only processes that the server has permission to terminate can be killed
System processes and processes owned by other users will return a 403 error
Always validate the PID before calling this endpoint to avoid unintended termination

Example Usage

// Kill a process from the connections list
const killProcess = async (pid: number) => {
  try {
    const response = await fetch('/api/connections/kill', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ pid })
    });
    
    if (!response.ok) {
      const error = await response.json();
      console.error(`Failed to kill process: ${error.error}`);
      return false;
    }
    
    const data = await response.json();
    return data.ok;
  } catch (error) {
    console.error('Network error:', error);
    return false;
  }
};

Get Connections

TypeScript Types

​Endpoint

​Request

​Example Request

​Response

​Success Response (200)

​Error Responses

​400 Bad Request

​403 Forbidden

​404 Not Found

​500 Internal Server Error

​Implementation Details

​Security Considerations

​Example Usage

Endpoint

Request

Example Request

Response

Success Response (200)

Error Responses

400 Bad Request

403 Forbidden

404 Not Found

500 Internal Server Error

Implementation Details

Security Considerations

Example Usage