Virtual APIs Tile

Applies to ReadyAPI 3.53, last modified on June 26, 2024

You can quickly start virtual APIs (or virtual services) from the Virtual APIs tile. It also provides additional information about the available virtual services. Below is a sample view of the tile:

Virtual APIs Tile

If you do not have a virtual service, or if you have not connected to it yet, you will see sample data in the tile. To learn about creating virtual services, see Creating Your First Virtual Service.

With this tile, you can start either all or several virtual services. To start all the service, click . To stop all the services, click .

The tile contains a table that lists –

  • Virtual services found in the projects of the current workspace.

  • Virtual services found on the servers that were added to the projects of the current workspace.

  • Virtual services found on the servers that were discovered automatically in your local network (ReadyAPI needs to find and connect to the server).

The table has the following columns:

Column Description
Name The virtual service name. Click it to open the virtual API service in the respective editor.
Status Indicates whether the virtual service is running and shows the run time. Click to run or to stop this service.
Location The name of the project the virtual service belongs to.
Port A port for the virtual service.

You can rearrange the table by moving its columns.


To use the Virtual APIs tile, you need a ReadyAPI Virtualization Pro license. If you do not have it, you can either request it on our web site or start a trial.

Add Virtual APIs

ReadyAPI fills in the list of virtual services automatically. Once it detects a virtual service running on the local computer, it adds that service to the list. The tile also searches for virtual APIs on the servers added to your test project and in the local network: it searches for VirtServer instances running in your local network and searches for virtual APIs on them. If some server stops responding, or if the connection to it fails (for example, the server can stop working, or is restarting, or there are some network issues, or other problems), a two-minute timeout is set for it. During this timeout, the tile will not try to establish a connection to it.

If you do not have any available virtual services, the tile displays sample data. In this case, you can add virtual services to the tile manually. To do this, click Create a virtual API on the tile (this button is visible only if the tile has no info on virtual services), and follow the instructions in the subsequent wizard. You can create a virtual service from –

In order for ReadyAPI to find virtual services in your local network, you need to enable the virtual service discovery and connect to VirtServer instances using the username and password specified in the Virtual Services of the ReadyAPI Virtualization editor. See also Connect With ReadyAPI.

Search for Virtual APIs

You can quickly find the virtual service you need by using the Search Table field.

ReadyAPI Dashboard: Search for a virtual API

Click the image to enlarge it.

To narrow down the search scope, select the conditions from the drop-down list.

Option Description
All Searches Name, Location and Port columns.
Location Searches the Location column.
Running Displays all virtual APIs that are running. The search field is disabled.
Stopped Displays all virtual APIs that are not running. The search field is disabled.

Export Details

Click or right-click anywhere in the Virtual APIs tile and select Generate Report. ReadyAPI will generate and open the report. Use the dialog toolbar to save the report or print it.

See Also

About ReadyAPI Dashboard
About Virtualization in ReadyAPI
ReadyAPI Virtualization Licenses

Highlight search results