GET /health/metrics/qradar_metrics/{id}

Retrieves the QRadar health metric identified by ID.

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

Table 2. GET /health/metrics/qradar_metrics/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	String	text/plain	The metric_id of the metric to get.
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.

Table 3. GET /health/metrics/qradar_metrics/{id} response codes
HTTP Response Code	Unique Code	Description
200		The QRadar resource defined by the QRadarMetric DTO.
404	1013	404 The metric identified by metric_id does not exist.
500	1020	500 Internal Server Error.

Response Description

The QRadar resource 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
}