Skip to main content

Processes API

The Processes API allows you to view the discovered-process registry and toggle the monitoring state for specific processes. Processes that are marked as monitored will be promoted to the topology.

List Discovered Processes

GET /api/processes

Returns a paginated list of discovered processes.

Query Parameters:

  • q (String): Search query to filter processes.
  • monitored (Boolean): Filter processes based on whether they are currently monitored.
  • page (Integer): The page number to retrieve. Defaults to 1.
  • pageSize (Integer): The number of items per page. Defaults to 20, maximum 100.

Set Process Monitoring State

PUT /api/processes/{identity}/monitor

Sets the monitoring toggle for a specific process identity. When set to true, the process is promoted to the topology.

Body Parameters:

  • monitored (Boolean): Whether this process identity should be monitored.