Skip to content

REST POST profiles id start

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

REST: POST /profiles/:id/start

Starts the Java process for a profile.


Request

POST /profiles/:id/start

Path parameters

Parameter Type Description
id string Profile UUID

No body.


Response

200 OK

{
  "ok": true,
  "pid": 14920
}

400 Bad Request — process already running, or jarPath is empty:

{
  "ok": false,
  "error": "Process already running"
}
{
  "ok": false,
  "error": "No JAR file specified"
}

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


Notes

The process is spawned using the configuration stored in the profile at the time of this call. Subsequent profile saves update the auto-restart snapshot but do not affect the running process until it is restarted.

Console output is not streamed over this endpoint. For real-time output see the push events in the IPC API or implement a WebSocket layer on top of processManager.

Clone this wiki locally