Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /health/metrics/qradar_metrics/{id}

Retrieves the JSA health metric identified by ID.

Retrieves the JSA 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 JSA 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 JSA 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 - JSA component name to query the mbean.

  • component_type - Enumeration - JSA component type to query the mbean.

  • enabled - String - Boolean to represent if the metric is enabled or not.

Response Sample