Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /health/metrics/qradar_metrics/{id}

 

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

Updates the time_resolution and enable field of a JSA 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 JSA 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