REST API Monitor Troubleshooting Guide
Whether you're adding a new REST API monitor or troubleshooting an existing one, the following steps can help resolve common issues.
Troubleshooting 4xx Error Codes (e.g., 401, 403)
Check Request Configuration:
- Verify that the correct HTTP method (GET, POST, etc.) and request payload (body or query parameters) are set up according to the API's documentation.
Verify Authentication Credentials:
- Manual Authentication: If you’re manually entering credentials (username/password), double-check that they are correct.
- Configured Credentials: If using pre-configured credentials, go to Settings → Credentials Settings to ensure the username and password are valid.
- OAuth: Go to Settings → Credentials Settings → OAuth Provider. Ensure that the access token is valid, has the necessary scope, and has not expired. If expired, click Authorize to refresh the token.
- Web Token: Go to Settings → Credentials Settings → Web Token and confirm that the token hasn't expired. If it has, check the refresh interval time to ensure it’s being renewed correctly.
Validate API URL:
- Test the API URL directly in a browser or with an HTTP client (such as Postman) to confirm the URL is correct and accessible.
Check for Proxy Requirements:
- If a proxy is required to access the API, make sure it’s correctly configured in Applications Manager under Settings -> Proxy Server Settings.
Troubleshooting 5xx Error Codes (e.g., 500, 502)
Check API Server Configuration:
- Confirm that the API server is configured correctly and is able to handle requests from Applications Manager. Double-check any specific configurations such as request headers or body format.
Review API Server Logs:
- If the API server is running, check the server logs to identify how the requests from Applications Manager are being handled. Look for errors that might suggest issues with processing the request.
Server Availability:
- Verify that the API server is operational and has the capacity to handle incoming requests from Applications Manager.
Additional Troubleshooting Tips
- If you’re encountering issues after monitor creation, it’s likely that an authentication token (OAuth or Web Token) has expired or changed. Verify that the token is still valid and update it if necessary.
- After monitor creation, if there are changes to authentication credentials (username/password, OAuth, Web Token), you’ll need to revisit the monitor’s configuration by editing it. Ensure the correct credentials are entered.
- Refer the link to troubleshoot other API response codes.
Still facing issues?
If the problem persists, contact our support team along with the following details:
- A screenshot of the "Add Monitor" page.
- The URL debug tool response for the REST API monitor.
- 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 ADSelfService Plus?
Related Articles
REST API Monitor - FAQS
What to Do When Basic Authentication Fails in REST API Monitor: When Basic Authentication fails in the REST API monitor, follow these steps to troubleshoot and resolve the issue: Verify Credentials: Ensure the credentials provided in Applications ...Real User Monitor (RUM) - Troubleshooting
If the monitor has not polled data for a long time, follow the steps below for troubleshooting: Step 1: Check the RUM Agent configuration Real User Monitor requires the RUM Agent to be installed and mapped to the Applications Manager. Refer the help ...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 ...