v16.7.2

List all known processes

Changed on

List all known processes. Use the query parameter to filter the listed processes.

get/api/v3/process

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v3/process
  • Auth
    API key in header Authorization

Query parameters

filterstring

Comma separated list of fields (config, state, report, metadata) that will be part of the output. If empty, all fields will be part of the output.

referencestring

Return only these process that have this reference value. If empty, the reference will be ignored.

idstring

Comma separated list of process ids to list. Overrides the reference. If empty all IDs will be returned.

idpatternstring

Glob pattern for process IDs. If empty all IDs will be returned. Intersected with results from refpattern.

refpatternstring

Glob pattern for process references. If empty all IDs will be returned. Intersected with results from idpattern.

Response

OK

created_atinteger
idstring
metadataunknown
referencestring
typestring
updated_atinteger

Changes