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.
- Select .
- Add an Application Profile as described in Working with Application Profiles.
- Add a Component as described in Components, Critical Component Groups, and Discrete Applications.
- In the , select the tab and click the + button to add a new component.
- In the Component Name window, select .
- In the Component Editor, configure the following fields.
- . Enter a unique name for the component. This name displays in the Components page of the Application Profile Editor.
- . Enter additional information for the component.
- . Select if this is a critical component.
- . Select if you want to enable a device to override this component.
- . Select the interval when the component is checked.
- . Select the length of the request before timeout.
- . Add the URL for the REST API endpoint for the component.
: 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 if tested. It is recommended to ensure the REST API returns a valid response before parameterizing the expression and attaching it to a device.
- . Select the supported HTTP method for the REST API endpoint. Currently, only the GET method is supported.
- . Enable this checkbox to force WhatsUp Gold to disregard any certificate errors.
- . If the REST API endpoint does not require authentication, check this box.
- . 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.
: For more information about JSONPath and JSONPath Builder, see JSONPath Query and 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.
- . Define a warning threshold for the JSON value you are monitoring.
- . Define a down value for the the JSON value you are monitoring.
- Select to run the REST API.
- Select to exit the component editor.
To add this component to an existing application profile on a device.
- Go to Monitored Applications, and select the + button.
- Add the Application Profile you created, and the device to attach the application profile to.
- Configure additional fields as required.
- Click .
The Component test is run on the device.