Open topic with navigation
You can upload API tests created with Ready! API or SoapUI as monitors in AlertSite. This allows you to monitor the availability and performance of your SOAP, REST and JSON APIs from AlertSite’s global monitoring network.
Basic knowledge of Ready! API or SoapUI is recommended to use API monitors.
The following assumes that you have an existing API test project and that it meets the requirements for running remotely. Specifically, the test case should include assertions so that AlertSite can determine that the API is working correctly and returns the expected result.
If you do not have a project, see API Monitoring Tutorial to learn how to create API tests in Ready! API or SoapUI.
Note: Only Admin and Co-Admin users can create and configure monitors.
Before you upload your Ready! API or SoapUI project to AlertSite, make sure it meets the following requirements:
Your test case should include assertions to verify the API call results. Without assertions AlertSite can only check the API availability but not the API call results.
AlertSite will report failed assertions as availability errors, for example:
If your test case requires specific values of SoapUI global preferences (for example, Request compression), these preferences must be set explicitly from your project, either through a setup script or using the Groovy Script test step.
For example, to set the Preferences > HTTP > Request compression option, you can use this Groovy code:
To learn more about scripting in Ready! API and SoapUI, see documentation for Scripting and the Script Library.
First, export your API test project to a ZIP file:
In Ready! API or SoapUI, select Project > Export from the main menu.
In older SoapUI versions, right-click the project in the Navigator and select Export from the context menu.
Then, in AlertSite UXM:
Select the AlertSite plan to be used for this monitor and click Continue.
Note: For internal APIs monitored only from Private Node Server locations, select the VM Node or InSite plan.
Browse for your exported API test project.
Select the test suite and test case to be run, and click Next.
After you created the monitor, you can select locations for monitoring and change other settings. To do this, click the monitor on the Dashboard, then click on the mini toolbar. For a description of available settings, see SoapUI API Monitor Settings.
Ready! API v. 1.3.1 and later, and SoapUI 5.2 and later include the AlertSite Connector plugin that allows you to upload your projects as monitors in AlertSite.
To create an API monitor using AlertSite Connector:
In Ready! API:
This will open the AlertSite Connector.
Enter your AlertSite email and password and click Connect.
Click Add Monitors in the top left.
If you have several plans, select the Plan to be used for this monitor.
Note: For internal APIs monitored only from Private Node Server locations, select the InSite or VM Node plan.
You will see the API Status page with your monitor added. The monitor will start running shortly, and you will see its status.
If you need to change the monitor settings (run interval, monitoring locations, and other), use the Click here link to open AlertSite and proceed from there. For details, see Editing a Monitor.
You can download API test projects from AlertSite to review or update them:
Click Download Project and save the zipped project to your computer.
Note: If you do not see the Download Project button, this monitor is a basic API endpoint monitor, and it does not run any SoapUI tests.
You can open the downloaded project in Ready! API or SoapUI by using the File > Import Packed Project menu item.
To upload an updated or new SoapUI project for the monitor:
Click Upload Project and browse for the exported project.
Note: If you do not see the Upload Project button, this monitor is a basic API endpoint monitor, and it does not run any SoapUI tests.
Internal monitoring is available on AlertSite Enterprise plans. You can set up private nodes (private monitoring locations) on your local network to monitor the applications and APIs behind the firewall. Private nodes work just like AlertSite’s global locations and send the availability and performance data to AlertSite where you can review it.
When creating monitors for internal APIs, make sure to select the VM Node or InSite measurement plan.
Yes, provided that the data is stored directly in the SoapUI project or fetched from the API during the test. That is, no external dependencies. For example, Grid data sources are OK to be used, but not Excel or JDBC.