POST /health/metrics/qradar_metrics/{id}

Updates the time_resolution and enable field of a QRadar metric identified by metric ID.

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

Table 2. POST /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	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/qradar_metrics/{id} request body details
Parameter	Data Type	MIME Type	Description	Sample
qradar_metric	Object	application/json	The updated QRadar Metric DTO with time_resolution and enabled fields. Only the enabled and the time_resolution fields are modifiable. Rest of the fields are ignored. The enabled field must be a valid boolean and time_resolution must be a valid long value.	{ "component_name": "String", "component_type": "String", "enabled": true, "metric_id": "String", "time_resolution": 42 }

Table 4. POST /health/metrics/qradar_metrics/{id} response codes
HTTP Response Code	Unique Code	Description
200		The Metric was retrieved.
404	1013	404 The metric identified by metric_id does not exist
422	1010	422 The time_resolution cannot be less than 5000.
500	1020	500 Internal Server Error.

Response Description

An Metric objects identified by the metric_id. A Metric object contains the following fields:

Id - String - The ID of the metric to update.
qradar_metric - QradarMetric DTO - The updated QRadar Metric DTO with time_resolution and enabled fields. Only the enabled and the time_resolution fields are modifiable. Rest of the fields are ignored. The enabled field must be a valid boolean and time_resolution must be a valid long value.

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
}