Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /health/metrics/system_metrics_global_config

Updates the frequency and enabled value of all the qradar metrics identified by metric_id parameter.

Updates the frequency and enabled fields of all the system metrics.

Table 1: POST /health/metrics/system_metrics_global_config Resource Details

MIME Type

application/json

Table 2: POST /health/metrics/system_metrics_global_config Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: POST /health/metrics/system_metrics_global_config Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

global_config

Object

application/json

GlobalMetricConfiguration DTO. This DTO has time_resolution and enabled fields in JSON format.

{ "enabled": true, "time_resolution": 42 }

Table 4: POST /health/metrics/system_metrics_global_config Response Codes

HTTP Response Code

Unique Code

Description

200

 

Global system metric configuration resource defined by the GlobalMetricConfiguration DTO.

422

1010

The time_resolution value cannot be less than 5000.

422

1014

Time_resolution and enabled both cannot be empty.

500

1020

Internal Server Error.

Response Description

A GlobalMetricConfiguration DTO. A GlobalMetricConfiguration object contains the following fields:

  • global_config - The GlobalMetricConfiguration DTO provides the time_resolution and enabled fields in JSON format.

Response Sample