SV Server REST Management API
The SV Server REST Management API enables you to write applications to perform all SV Server functionality (interact/control) without using the Service Virtualization user interface.
Overview
There are currently two versions of the SV Server REST Management API available: API version 1 is intended for internal use only; API version 2 can be utilized by anyone.
The OpenAPI documentation of the APIs is available from https://host:6085/api/swagger.
Note:
-
While limited OpenAPI documentation is provided for SV Server REST Management API v1, this version is not meant for public use. Incorrect usage of SV Server REST Management API v1 can result in unexpected problems, and no support will be provided for problems caused as a result of using it.
-
Most API actions require you to authenticate to the SV Server via HTTP Basic authentication.
Using the SV Server REST Management API
SV Server REST Management API version 2 is organized into the following groups of operations: Agents, Services, and Download.
Agents |
You can list basic details about the agents deployed on the server which you have permissions to view or use. You can enable or disable an agent, delete it, change its name, or export the agent XML configuration. Note: You can import an exported agent to a different Service Virtualization environment upon saving the obtained XML configuration as a file, compressing it using Zip, and changing the file extension to *.agce. |
Services |
Managing Services (operations starting with “/v2/services”):
Deploying Services (mostly operations starting with “/v2/deployer”): You can deploy services from a *.vproja archive file, which you can obtain by exporting project files to an archive file in SV Designer, or you can export deployed services from SVM, or using the methods of this public API. To deploy services you need to create a Deployer. The Deployer unpacks the *.vproja archive file, and enables you to make changes to it such as specifying a different agent mapping. When the project is ready to be deployed, you can initiate the deployment. To deploy services:
|
Download |
Operations that start with “/v2/download” facilitate the download of files that are not ready immediately. Certain operations such as “/v2/services/{virtualServiceId}/export” retrieve the File ID, instead of the file itself. To download the file:
|
For additional details, see https://host:6085/api/swagger.