Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Announcement: Try the Ask AI chatbot for answers to your technical questions about Juniper products and solutions.

close
header-navigation
keyboard_arrow_up
close
keyboard_arrow_left
REST API Version 17.0 References
Table of Contents Expand all
list Table of Contents
file_download PDF
{ "lLangCode": "en", "lName": "English", "lCountryCode": "us", "transcode": "en_US" }
English
keyboard_arrow_right

GET /health/metrics/system_metrics

date_range 24-May-22

SUMMARY Gets the list of system metrics.

Gets the list of system metrics.

Table 1: GET /health/metrics/system_metrics resource details:

GET /health/metrics/system_metrics resource details

MIME Type

application/json

Table 2: GET /health/metrics/system_metrics request parameter details:

GET /health/metrics/system_metrics request parameter details

Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

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.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3: GET /health/metrics/system_metrics response codes:

GET /health/metrics/system_metrics response codes

HTTP Response Code Unique Code Description

200

A list of system metrics defined by the SystemMetric DTO.

500

1020

Internal Server Error.

Response Description

A list of system metrics defined by the SystemMetric DTO.
  • metric_id - String - Unique ID of the metric.
  • time_resolution - Long - Time frequency in milliseconds at which the metric is polled.
  • enabled - String - Boolean to enable or disable the metric.

Response Sample

content_copy zoom_out_map
[
    {
        "enabled": true,
        "metric_id": "String",
        "time_resolution": 42
    }
]
footer-navigation