Skip to content

REST GET profiles id state

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

REST: GET /profiles/:id/state

Returns the current runtime state of the process for a given profile.


Request

GET /profiles/:id/state

Path parameters

Parameter Type Description
id string Profile UUID

No body.


Response

200 OK — whether or not the process is running.

{
  "profileId": "550e8400-e29b-41d4-a716-446655440000",
  "running": true,
  "pid": 14920,
  "startedAt": 1700000000000
}

When not running:

{
  "profileId": "550e8400-e29b-41d4-a716-446655440000",
  "running": false
}

Fields

Field Type Present when Description
profileId string always Profile UUID
running boolean always Whether a process is active
pid number running OS process ID
startedAt number running Unix ms timestamp of start
exitCode number stopped, if available Last exit code

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

Clone this wiki locally