List processes

Returns process snapshots filtered by optional ref, state, and status query parameters. The status filter accepts the terminal exit states (success, failed, timeout, canceled) or ‘null’ to match processes that have not finished.

GET /processes

List processes

cURL

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

200

{
  "processes": [
    {
      "id": 1,
      "error": "<string>",
      "createdAt": "<string>",
      "completedAt": "<string>",
      "ref": "<string>"
    }
  ]
}

Query Parameters

ref · string

Optional reference string used to filter processes.

state · enum<string>

Current lifecycle state of a process.

Available options: queued, running, idle, terminating

status · enum<string>

Filter processes by terminal exit state. Use 'null' to match processes that have not finished.

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

Response

200

application/json

Matching processes.

Collection wrapper for process listings.

processes · object[] · required

Processes that match the provided query filters.

Show child attributes