GET /health/metrics/qradar_metrics

Gets the list of QRadar component metrics

Gets the list of QRadar component metrics.

Table 1. GET /health/metrics/qradar_metrics resource details
MIME Type
application/json

Table 2. GET /health/metrics/qradar_metrics request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
fields	query	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.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3. GET /health/metrics/qradar_metrics response codes
HTTP Response Code	Unique Code	Description
200		A list of resources defined by the QRadarMetric DTO.
500	1020	Internal Server Error.

Response Description

A list of resources defined by the QRadarMetric DTO.

Id - String - Unique ID of the metric.
time_resolution - Long - Time frequency in milliseconds at which the metric is polled.
component_name - String - QRadar component name to query the mbean.
component_type - Enumeration - QRadar component type to query the mbean.
enabled - String - Boolean to represent if the metric is enabled or not.

Response Sample


[
    {
        "component_name": "String",
        "component_type": "String <one of: ACCUMULATOR, ARIEL_PROXY_SERVER, ARIEL_QUERY_SERVER, ARC_BUILDER, ASSETPROFILER, ECS_EP, ECS_EC, ECS_EC_INGRESS, HISTORICAL_CORRELATION_SERVER, HOSTCONTEXT, OFFLINE_FORWARDER, QVMPROCESSOR, REPORTING_EXECUTOR, TOMCAT, JAVA>",
        "enabled": true,
        "metric_id": "String",
        "time_resolution": 42
    }
]