Update Virtual Service Ports on VirtServer

Applies to VirtServer 3.20.0, last modified on May 16, 2024

By default, when a virtual service (virtual API) is deployed to VirtServer, it uses the port you specified in ReadyAPI. However, on VirtServer, the port may be used either by another service that is running on VirtServer, or by some other resource running on the computer where VirtServer is hosted.

VirtServer does not reassign the port automatically in this case. Instead, it completes the deployment and displays a message informing you about the issue:

API testing with ReadyAPI: Warning message on conflicting port settings

In this case, you need to change the port settings of your virtual service on VirtServer.

Note: VirtServer checks the ports of running virtual services only. If a service with the same port is not running, no warning will be displayed.
Note: If you are deploying a virtual service that is already on VirtServer (that is, if you are updating your virtual service), VirtServer will complete the deployment and then check the port numbers. If the ports differ, VirtServer will automatically use the port that is set on VirtServer for the deployed service. It will also display a message informing you about the change. If the ports are the same, no message will be shown.

Note: You can only update ports for virtual services that are assigned to the group you are in or not assigned to any group.

Using ReadyAPI

To override the virtual service port on VirtServer from ReadyAPI:

  • Select the virtual service on the Virtual Services page of the VirtServer panel. You will see the service’s properties on the right.

  • Set a new port in the Port edit box and click Change port.

    – or –

    Click Auto-assign a free port:

    API testing with ReadyAPI: Changing virtual service port on VirtServer

    Click the image to enlarge it.

    The virtual service port will be changed on VirtServer only. On your computer, the service will use the same port it used before the deployment.

Using web interface

To change the port from the VirtServer web interface:

  • Go to the home page of VirtServer:


    For example, if VirtServer is installed on your local machine and you run it on the default port, use the following link:

  • Click the port number in the Port column for your virtual service:

    API testing with ReadyAPI: Accessing virtual service settings in VirtServer web interface

    Click the image to enlarge it.

  • Enter a new port value and click Save. If the port is already used, VirtServer will warn you about the issue. Click Assign Available Port to assign the closest available port.

    API testing with ReadyAPI:Assigning available ports

    Click the image to enlarge it.

To change a virtual service port on VirtServer with the command-line utility, use the -update command. You can read more about it in this topic.

Tip: Specifying virtual service port in tests

When creating tests for a virtual service, you may not know the port it will use on VirtServer. If you hard-code the port number in your tests, you will need to change it after the service is deployed to VirtServer. As a workaround, you can create a project-level or test-suite-level property that will store the virtual service address and port values and specify this variable as the Endpoint property of your test requests. If the port number changes, you will need to modify the project-level (or test-suite-level) property, rather than update the Endpoint properties in all the requests:

API testing with ReadyAPI: Setting endpoint

Click the image to enlarge it.

See Also

User Tasks

Highlight search results