REST API Performance (Application)

The REST API performance monitor component allows you to run the monitor on a specific device, and to gain information about the health of a device, server, or application by evaluating the output against a threshold.

To add a REST API performance monitor as a component to an existing application.

  1. Select Settings > Application Monitoring > Application and Profile Setup.
  2. Add an Application Profile as described in Working with Application Profiles.
  3. Add a Component as described in Components, Critical Component Groups, and Discrete Applications.
  4. In the Application Profile Edit, select the Components tab and click the + button to add a new component.
  5. In the Component Name window, select REST API > REST API Performance.
  6. In the Component Editor, configure the following fields.
    • Name. Enter a unique name for the component. This name displays in the Components page of the Application Profile Editor.
    • Description. Enter additional information for the component.
    • Critical. Select if this is a critical component.
    • Test Device override. Select if you want to enable a device to override this component.
    • Polling interval. Select the interval when the component is checked.
    • Connection timeout. Select the length of the request before timeout.
    • REST API. Add the URL for the REST API endpoint for the component.

    Note: Reference variables (also called Percent variables) for System (%System), Device (%Device), and Application (%Application) are supported in the REST API URL. For more information, see Percent Variables. However, the expression will evaluate to false if tested. It is recommended to ensure the REST API returns a valid response before parameterizing the expression and attaching it to a device.

    • Method. Select the supported HTTP method for the REST API endpoint. Currently, only the GET method is supported.
    • Ignore Certificate Errors. Enable this checkbox to force WhatsUp Gold to disregard any certificate errors.
    • Use anonymous access. If the REST API endpoint does not require authentication, check this box.
    • JSONPATH. Enter the path to the JSON object you want to monitor or use the JSONPath Builder to ensure you have the correct path to the object you want to monitor.

    Note: For more information about JSONPath and JSONPath Builder, see JSONPath Query and JSONPath Builder.

    • JSONPath Builder. After you enter a valid REST API URL endpoint, you can use the JSONPath Builder to view the structure of the JSON response and select which JSON value you want to monitor.
    • Thresholds
      • Warning. Define a warning threshold for the JSON value you are monitoring.
      • Down. Define a down value for the the JSON value you are monitoring.
  7. Select Test to run the REST API.
  8. Select Ok to exit the component editor.

To add this component to an existing application profile on a device.

  1. Go to Monitored Applications, and select the + button.
  2. Add the Application Profile you created, and the device to attach the application profile to.
  3. Configure additional fields as required.
  4. Click Save.

The Component test is run on the device.

See Also

Components, Critical Component Groups, and Discrete Applications

Cloud Monitoring for Azure

Cloud Monitoring for AWS

CPU Utilization

Database Query

Disk Utilization

File Content

HTTP Content Check

Interface Statistics

JMX Performance Check

Memory Utilization

Network Port Check

Process Check

REST API Active (Application)

Scripting (PowerShell)

Scripting (End User Monitor)

Service Check




Windows Performance Counter