REST API Monitor - FAQS

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:

  1. Ensure that the username and password provided in Applications Manager are correct.
  2. Try manually sending the username and password in the request header to verify the credentials:
    1. Combine the credentials in the username: password format (Example: admin: test)
    2. Encode this string in Base64 (Example result: YWRtaW46dGVzdA==).
    3. Add this encoded value under Custom HTTP(S) Headers using the format: Authorization_sep_Basic <Base64Value> (Example: Authorization_sep_BASIC YWRtaW46dGVzdA==)
    4. If there are multiple headers, use a hash (#) to separate the headers. 
  3. Perform Test Credential again to verify that the credentials pass successfully.
Notes
Note:
In Basic Authentication, a client typically makes an initial request without credentials. If the server responds with 401 Unauthorized, the client retries with credentials.
However, some servers immediately close the connection after a 401 response, causing Basic Authentication to fail. In such cases, sending the credentials directly through Custom HTTP(S) Headers avoids the issue.

2. How do I configure a browser User-Agent in the REST API monitor?

To configure the browser's User-Agent header, follow the steps below:
  1. Search "My User-Agent" in your browser. The first result will typically display your browser's User-Agent string.
  2. Add this value under the Custom HTTP(S) Headers field in the format User-Agent_sep_<Value> (Example: User-Agent_sep_Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36)
  3. If multiple headers are being used, separate them with a hash (#).
  4. Click on Test Credential to verify the response.

3. How to configure the appropriate Content-Type in the request header?

The Content-Type header tells the target server the format of the request payload. To configure it:
  1. Select the appropriate Content-Type based on your payload format:
    1. FORM → application/x-www-form-urlencoded
    2. Text → text/plain
    3. XML → application/xml
    4. JSON → application/json
  2. Add the header under Custom HTTP(S) Headers using the format Content-Type_sep_<Value> (Example: Content-Type_sep_application/json)
  3. Perform Test Credential to verify the response.