Get Process Tracker configuration

Prev Next

Use the following API request to get the current configuration tree for the Process Tracker module.

Request

HTTP Verb

Path

Parameters

GET

hx/api/services/config/tree

node_name=/config/process-tracker

Response

The returned information is a JSON dictionary with the following keys.

Key

Notes

Data

List of configuration properties. Each property has the following attributes:

  • name: the name of the configuration property.

  • type: the data type for this configuration property.

  • value: the current value of this configuration property.

  • default_value: the default value of this configuration property.

Configuration properties

Purpose

Path

Type {Values}

Enrichment

/config/process-tracker/enrichment/enabled

Boolean {true | false}

Logging level

/config/process-tracker/logging/level

String {‘debug’ | ‘info’ | ‘warning’ | 'notice’ | ‘error’ | ‘critical’ | ‘alert’ |

‘emergency’}

Aging setting

/config/process-tracker/aging/database/period

Int32 (number of seconds) Default = 30 days as seconds

Alert setting

/config/process-tracker/alerting/enabled

Boolean {true | false}

Sample response

{
    "data": [
        {
            "default_value": "2592000",
            "name": "/config/process-tracker/aging/database/period",
            "type": "int32",
            "value": "2592000"
        },
        {
            "default_value": "false",
            "name": "/config/process-tracker/alerting/enabled",
            "type": "bool",
            "value": "true"
        },
        {
            "default_value": "true",
            "name": "/config/process-tracker/enrichment/enabled",
            "type": "bool",
            "value": "true"
        },
        {
            "default_value": "notice",
            "name": "/config/process-tracker/logging/level",
            "type": "string",
            "value": "notice"
        }
    ]
}