REST API Monitor Troubleshooting Steps

REST API Monitor Troubleshooting Steps

1. I'm not able to add a REST API Monitor
  1. I'm getting a "Failed" message or 4xx error code:
    1. Check the request configuration: Ensure that the request type and the corresponding payload is correct.
    2. Check the Authentication details being sent with the request:
      1. If you are manually entering the username and password, re-check the credentials.
      2. In case you are selecting an already configured credential, go to Admin tab -> Credentials Settings -> Check the corresponding username and password.
      3. If you are using OAuth, go to Admin tab -> OAuth Provider. Check the if the OAuth Provider access token has expired and whether you have provided the necessary scope permissions required to get the data from the API. If the access token has expired, refresh the token by clicking on the "Authorize" button in the edit provider page.
    3. Check if the URL is valid:
      1. Access the URL in the browser and check the response code being returned
  2. I'm getting a 5xx error code: The error codes of the 5xx format are usually sent because the data being sent in the request could not be parsed correctly in the API webserver. Check the API webserver logs for the data being received from Applications Manager.
  3. I'm getting a 6xx error code: This response code is returned when Applications Manager is not able to establish a connection with the REST API. Check the accessibility of the URL from the server in which Applications Manager has been installed.
2. Error after monitor has been created
  1. I'm getting a 4xx error code:
    1. Check if the authentication credentials required by the API have changed. To check the credentials being sent from Application's Manager, Click on Edit Monitor. This will open the edit monitor page where all the authentication details are listed.
    2. If you are manually entering the username and password for API authentication, recheck the credentials to ensure they are the valid for the API. 
    3. In case you are using an already configured credential, go to Admin tab -> Credentials Settings -> Check the corresponding username and password. Recheck the configured data to ensure they are the valid for the API. 
    4. If you are using OAuth, go to Admin tab -> OAuth Provider. Check the if the OAuth Provider access token has expired and whether you have provided the necessary scope permissions required to get the data from the API. If the access token has expired, refresh the token by clicking on the "Authorize" button in the edit provider page.

          • Related Articles

          • Service Now Event Integration using Webhook / Rest API Action

            Steps to perform in Service Now 1) Login to your ServiceNow Instance(dev*****133.service-now.com) 2) Search for the Rest API Explorer and open it 3) In the Rest API Explorer page choose the Namespace and API Name with the proper API version. For ...
          • Troubleshooting URL Monitor

            Here are few of the common errors you may come across in URL monitor, we have mentioned the steps you can follow to troubleshoot them.   General troubleshooting for URL monitor Ensure that the URL is accessible from the server in which Applications ...
          • OpenShift Monitoring in Rest API Mode

            For the OpenShift monitor, data collection happened using SSH mode which resulted in timeout exception due to the presence of large amount of data. To avoid the timeout exception, enhancement has been made such that data collection takes place using ...
          • IIS Server monitor - Troubleshooting steps

            Troubleshooting guide for adding an IIS Server monitor Troubleshooting 'No data available' error for IIS Server performance metrics (IIS Websites and Application Pools statistics)
          • Troubleshooting Brand Reputation Monitor

            Web Risk API is not reachable Brand Reputation monitor uses Google's Web Risk API for data collection. Hence Google services should be reachable from the server in which Applications Manager server for monitor's data collection to happen. To ...