Page tree

Skip to end of metadata
Go to start of metadata

This topic introduces the Parasoft REST API, which  allows you to remotely create and update virtual assetsortest assets directly on the Parasoft server. This enables third-party integrations, custom programmatic interactions, and access via additional user interfaces such as Parasoft CTP.

Sections include:

Related APIs

The REST API covered in this topic focuses on operations associated with creating and updating virtual and test assets. Virtualize and SOAtest also includes a SOAP-based API that focuses on the management, execution, and deployment of virtual and test assets. See Testing from the Web Service Interface and Managing Virtualize Servers Through the Web Service Interface

 for more information about the SOAP-based API.


  • The SOAtest server must be running
  • The Virtualize server must be running

  • Server API-enabled license

How do I start SOAtest Server

From the cli: soatestcli -startServer
From the UI: Click the Start Server button in the SOAtest Server view.

If the Start Server button is grayed out and the red Stop Server button is enabled, this means that the server is running.

Make Sure Your License Supports SOAtest Server

If you using the combined SOAtest/Virtualize distribution, a Virtualize license is required to run SOAtest Server. In some instances, you may only have a license for SOAtest, i.e., if you are updating to a paid license from the Community License. Contact your Parasoft representative for additional information about licensing options.

About the REST API

The REST API enables you to perform core operations, without using the desktop GUI, as well as integrate with other applications or tools that part of your Dev/Test infrastructure. You can create, update, and delete data sources, test suites, virtual assets,tools, environments, etc. For details, see the API documentation by opening the following URL in a browser:


Your tools may be deployed on different ports.

Returning Requests in GZIP Format

The REST API can return requests in GZIP format. This results in smaller payloads being sent over the wire, which decreases the amount of time it takes to read responses from the server.

To have requests returned in GZIP format, the client accessing the REST API just needs to set the following HTTP header:
Accept-Encoding: gzip

  • No labels