List processes

Returns process snapshots filtered by optional ref, state, and status query parameters. The status filter accepts success, failed, timeout, canceled, or null.

GET /processes

List processes

cURL

curl --request GET \
  --url http://localhost:7687/processes

200

{
  "processes": [
    {
      "pid": 1,
      "ref": "<string>"
    }
  ]
}

Query Parameters

ref · string

Optional reference string used to filter processes.

state · enum<string>

Current lifecycle state of a process.

Available options: idle, queued, running, terminating

status · enum<string>

Filter processes by terminal status; use null to include non-terminal processes.

Available options: failed, success, timeout, canceled, null

Response

200

application/json

Matching processes.

Collection wrapper for process listings.

processes · object[] · required

Processes matching the provided query filters.

Show child attributes