Creating an API Endpoint Monitor

An API endpoint monitor sends an HTTP request to the specified URL and checks the response time and status. You can specify the request headers and payload, such as JSON or XML data.

API endpoint monitors can be used for both REST and SOAP APIs.

Basic knowledge of HTTP request and response contents is recommended to use API endpoint monitors.

 

To create an API endpoint monitor:

  1. On the AlertSite UXM Dashboard, click the big +, then click + New Monitor.
  2. Select API, then Single API Endpoint Monitor.
  3. Enter the request URL, including http:// or https:// and the query string parameters, if any. Examples of valid URLs:

    http://example.com
    http://api.example.com:8089/photos
    https://api.example.com/photos?tags=ocean&limit=10

    Note: Query string parameters should have unique names. Multiple parameters with the same name are not supported.

  4. Select the request method – GET, POST, HEAD, PATCH, PUT or DELETE.

    API endpoint monitor: request URL and method

  5. Give the monitor a name and select the billing plan. Note that VMNode and InSite plans and locations are not currently supported for API endpoint monitors.

  6. Click Next.
  7. Specify the request headers and body, if applicable.
  8. If you are sending a request body, make sure to select the appropriate Content-Type from the list or specify it as a header.

    Request headers and body

    Tip: If sending JSON or XML, make sure the syntax is correct. You can verify JSON syntax using jsonlint.com and XML syntax using www.xmlvalidation.com.

  9. If the API uses Basic authentication, select Require authorization and enter the username and password.

    Username and password for Basic authentication

  10. Click Validate.
  11. AlertSite will send a sample request and display the response. Verify that the response is correct.

    API response

    If there is an error, go back and double-check the request configuration (URL, headers and body).

  12. (Optional.) If you want to verify that a specific value is present in the response, select this value in the response text and select the Use Above Selection for Keyword Validation check box. The presence of this value in the response will be one of the conditions for a successful test. A missing keyword will be reported as status 5 “Keyword verification error”.

    Keyword validation for API response

    Notes:

  13. Click Next.
  14. Select the monitor run interval, timeout and the locations where the monitor will run.

    Note: Private locations (Private Node Server and InSite) are not currently supported for the API endpoint monitors.

    Selecting locations for an API endpoint monitor

  15. Click Start Monitoring Now!. You will see a message saying that the monitor has been created.
  16. (Optional.) To review or change other monitor settings, click the link in the message.

    Click to edit monitor

    See API Endpoint Monitor Settings for a description of available settings. One useful setting is Capture Level, which lets you store request and response contents from the test runs.

Your monitor is ready! It will send requests to your API endpoint at the configured intervals. The first results will appear on the Dashboard in a few minutes.

What’s Next

See Also

© 2017 SmartBear Software. All rights reserved.      Terms of Use · Privacy Policy