REST API Monitor Troubleshooting Guide

REST API Monitor Troubleshooting Guide

Whether you're adding a new REST API monitor or diagnosing issues in an existing one, the steps below will help resolve the most common problems.

Troubleshooting 4xx Error Codes (e.g., 401, 403)

1. Check Request Configuration

Ensure that the following match the API documentation:
  1. HTTP method (GET, POST, PUT, etc.)
  2. Request payload (body, parameters)
  3. Required request headers
2. Verify Authentication Credentials

Basic / Manual Authentication:
    1. Confirm the username and password are correct.
    2. If using stored credentials, go to Settings → Credential Settings and verify validity.
OAuth:
    1. Go to Settings → Credential Settings → OAuth Provider.
    2. Ensure the access token is valid and has the required scopes.
    3. If expired, click Authorize to regenerate the token.
Web Token (JWT/Bearer Token):
    1. Go to Settings → Credential Settings → Web Token.
    2. Confirm the token has not expired.
    3. If using auto-refresh, ensure the refresh interval is configured correctly.
3. Validate API URL

From the Applications Manager server:
  1. Test the API endpoint using a browser, curl, or a tool like Postman.
  2. Ensure the endpoint is reachable and correct.
4. Check Proxy Configurations

If a proxy is used:
  1. Confirm it is configured and reachable under Settings → Product Settings → Proxy Server Settings.
  2. If certain hosts should bypass the proxy, add them under Do not use proxy for addresses beginning with.

Troubleshooting 5xx Error Codes (e.g., 500, 502)

1. Check API Server Configuration
  1. Confirm the API server can process requests sent from Applications Manager.
  2. Verify required headers, payload formats, and authentication parameters.
2. Review API Server Logs
  1. Check the server-side logs to see how incoming requests from Applications Manager are being processed.
  2. Look for misconfigurations or internal errors.
3. Confirm Server Availability
  1. Ensure the API server is up, healthy, and able to handle load from Applications Manager.
4. Proxy Requirement
  1. If the API requires a proxy, ensure it is configured in Applications Manager.
  2. If the API should bypass the proxy, add its host/IP under Do not use proxy for addresses beginning with.

Additional Troubleshooting Tips

  1. After monitor creation, authentication tokens (OAuth or Web Token) may expire or rotate. Verify the token and update it if needed.
  2. If authentication settings change (credentials, token, or OAuth), edit the monitor configuration and update the values.
  3. For additional API-specific response code troubleshooting, refer to the linked documentation.
Info
Still facing issues?
If the problem persists, contact our support team along with the following details:
  1. A screenshot of the "Add Monitor" page. 
  2. The URL debug tool response for the REST API monitor.
  3. Reproduce the issue and share the latest Support Information File (SIF) from Applications Manager, with the "Print all logs" option enabled. To do this, go to Settings > Logging, and choose "Print all logs".

      New to M365 Manager Plus?
      New to M365 Manager Plus?
        New to RecoveryManager Plus?
        New to RecoveryManager Plus?
          New to Exchange Reporter Plus?
          New to Exchange Reporter Plus?
            New to SharePoint Manager Plus?
            New to SharePoint Manager Plus?
                See all integrations
                New to ADManager Plus?
                See all integrations
                New to ADManager Plus?

                  New to ADSelfService Plus?

                  Start your free trial
                  Start your free trial

                    • Related Articles

                    • REST API Monitor - FAQS

                      1. What should I do when Basic Authentication fails in the REST API monitor? If Basic Authentication fails in the REST API monitor, follow the steps below to troubleshoot and validate the issue: Ensure that the username and password provided in ...

                    • Real User Monitor (RUM) - Troubleshooting guide

                      If your Real User Monitor has not collected data for an extended period, follow the steps below to troubleshoot the issue. Step 1: Verify the RUM Agent configuration Real User Monitoring requires the RUM Agent to be installed and mapped to ...

                    • DNS Monitor - Troubleshooting

                      Common DNS Monitor Errors and Troubleshooting Guide 1. Host Not Found Description: The DNS server was unable to locate the requested lookup address. Possible Causes: This may happen if the hostname is incorrect, the domain does not exist, or there is ...

                    • Mail Server Monitor - Troubleshooting

                      Common Mail Server Monitor Errors and Troubleshooting Guide 1. Unknown Host Error Description: This error occurs when the mail client cannot resolve the hostname of the mail server to an IP address. The issue typically arises from DNS resolution ...

                    • 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 ...

                      Related Products