REST API Active (Application)

The REST API active monitor component allows you to run the monitor on a specific device, and to gain information about the status of a device, server, or application by evaluating whether the monitor is up or down.

To add a REST API Active 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 dialog, select the Components tab, then click the Add icon to add a new component.
5. For Component Name, select REST API > REST API Active.
6. In the Component Editor, configure the following fields:
   • Name. Enter a unique name for the component. This name displays in the Performance Components page of the Application Profile Editor.
   • Description. Enter additional information for the component.
   • Critical. Select if this is a critical component.
   • 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.

   • Edit Custom Headers. Enter up to ten custom headers required to access the REST API endpoint. A default Accept header is provided and is specified as application/json.

   Note: For monitoring a Progress Application Server for OpenEdge OEManager REST API endpoint, the Accept header must be set to application/vnd.progress+json or */*.

   • 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.
   • Down Condition. The monitor will report as down if any of the HTTP response codes listed is returned. You can control which response codes indicate that the monitor is down, and you can also provide a JSONPath Query along with conditions to indicate if the monitor is down. The monitor can use either a Down Condition, a JSONPath Query, or both to return a down response.
   • JSONPATH Query. Design a logical test for evaluating conditions that the REST API endpoint returns:
   1. Select the Add icon to enter a conditional test using the JSONPath Query. By default, the "No Comparison Set" text appears in-line.
   2. Double-click inside the JSONPath Query entry, and then select the magnifying glass logo. This prompts you to enter a REST API Credential if "Use anonymous access" is not checked. After the REST API Credentials are verified, the JSONPath Builder window opens.
   3. Select the endpoint that you want to monitor.
   4. Build a logical test that represents a down condition for monitoring the REST API endpoint. Supported value types are Boolean, Number, String, and Other. The Other data type checks if a value is null. Empty strings are supported.
   5. Click Save.
7. Select Test to run the REST API.
8. Click Ok to exit the Component Editor.

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

1. Go to Monitored Applications, then select the Add icon.
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 Performance (Application) Scripting (PowerShell) Scripting (End User Monitor) Service Check SNMP SSH WMI Windows Performance Counter