GET /health/metrics/system_metrics/{id}

Edit online

Retrieves the system health metric identified by metric ID.

Retrieves the system health metric identified by metric ID.

Table 1. GET /health/metrics/system_metrics/{id} resource details
MIME Type

application/json

Table 2. GET /health/metrics/system_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/system_metrics/{id} response codes
HTTP Response Code Unique Code Description

200

System metric defined by SystemMetric DTO for the given metric ID.

404

1013

404 Resource Not Found if the metric_id does not exist.

500

1020

500 Internal Server Error.

Response Description

System metric defined by SystemMetric DTO for the given metric ID.
  • metric_id - String - The ID of the metric.
  • time_resolution - Long - Time frequency in milliseconds at which the metric is polled.
  • enabled - String - Boolean to represent if the metric is enabled or not.

Response Sample


{
    "enabled": true,
    "metric_id": "String",
    "time_resolution": 42
}