REST API (Performance)
The REST API performance monitor parses JSON-formatted REST API response data to extract performance metrics. The JSON response from the REST API call must contain a numeric field that returns a health-metric for the device, server, or application.
Configure the following fields to set up a REST API Performance Monitor:
- . Enter a unique name for the monitor. This name displays in the Performance Monitor Library.
- . Enter additional information for the monitor. This description displays next to the monitor name in the Performance Monitor Library.
- . Enter the amount of time WhatsUp Gold waits for the REST API to respond before terminating the connection and returning the timeout error. The minimum allowed value is 1 second whereas maximum allowed value is 120.
- . Enter up to ten custom headers required to access the REST API endpoint.
- . The URL for the REST API endpoint that you want to monitor.
: 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 with the button. It is recommended to ensure the REST API returns a valid response before parameterizing the expression and attaching it to a device.
- . Select a 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. The JSONPath must refer to a numeric field in the response from the REST API call.
: For more information about JSONPath and JSONPath Builder, see JSONPath Query and JSONPath Builder.
- . After you enter a valid REST API URL endpoint, use the JSONPath Builder to view the structure of the JSON response and select the numeric JSON value you want to monitor.
Click to ensure you have entered a valid configuration for the REST API performance monitor.