Skip to content

REST POST profiles id stop

Timon Home edited this page Mar 19, 2026 · 1 revision

REST: POST /profiles/:id/stop

Stops the running process for a profile.


Request

POST /profiles/:id/stop

Path parameters

Parameter Type Description
id string Profile UUID

No body.


Response

200 OK

{
  "ok": true
}

400 Bad Request — process is not running:

{
  "ok": false,
  "error": "Not running"
}

404 Not Found — no profile with the given id exists.


Platform behaviour

OS Method
Windows taskkill /PID {pid} /T /F — kills entire process tree, forced
Unix SIGTERM, then SIGKILL after 5 seconds if still alive

Stopping via this endpoint marks the process as intentionally stopped, which suppresses the auto-restart mechanism regardless of the autoRestart profile setting.

Clone this wiki locally