You are here: Home > Products > Network Monitor (Pro) > User Manual > Network Monitoring Checks > REST API Monitoring

REST API (JSON) Monitoring

REST (REpresentational State Transfer) is a way of interacting and exchanging data in distributed systems (for example, web services). In general, REST is a very simple information management interface without the use of any additional internal layers. Each piece of information is uniquely identified by a global identifier such as a URL. In simple terms, REST is the ability of the system to provide a well-formed JSON or XML response to an HTTP request. The response may contain parameters of interest to the requester.

Some computer hardware monitoring programs can transmit the values of the system parameters (fan speed, processor temperature, memory load, etc.) through the built-in HTTP server. For example, OpenHardwareMonitor can do this.

 

If you enable the built-in web server in the program settings, it can return the result in the JSON format upon the GET http://172.18.25.113:8085/data.json request:

The JSON contains all the values of the variables that the program receives from local sensors during its operation.

Our program can parse such answers and get the values of interest from them. In order to configure the check, you need to set at least 2 parameters.

  1. REST API URL. This is the link where the third-party system or application returns a JSON response (XML is currently not supported).
  2. Full path to the parameter of the value you want to get. JSON has a tree structure, so it is necessary to specify not only the name of the parameter itself, but also all its parent nodes. To make this easy, the program displays the received JSON in the form of a tree, in which you can select the desired parameter. After that, the full path will be generated automatically.

 

The additional check parameters are optional and can be configured if necessary.

  • HTTP request type (GET or POST)
  • Web server authorization
  • Proxy settings
  • Conditions for passing the check

 

With the REST API monitoring check, you can monitor an unlimited range of systems and applications that support the REST API.

 

Requirements: Windows XP/Vista/7/8.1/10/11, Server 2003/2008/2012/2016/2019/2022 supported.