HTTP/HTTPS Gateway agent settings

This dialog box enables you to configure the Service Virtualization HTTP/HTTPS Gateway agent. The agent handles communication between a client and a real or virtual service.

To access
  1. From the main menu, select Tools > Options.
  2. Click Agents.
  3. Under HTTP(S) Gateway, select a configuration.
Important information
Relevant tasks
See also Service Virtualization agents

User interface elements are described below (unlabeled elements are shown in angle brackets):

UI Element Description
<left pane>

Displays the server configured for your project.

Expand the server to display the available agents and configurations.


Enables you to define additional configurations of the agent.

Delete Deletes the selected configuration.

Creates an additional configuration of the agent by copying the selected configuration. You can then modify the configuration settings.

Note: By default, the configuration is created with a sequential unoccupied port number.


Saves the selected agent configuration as a file. The file is saved in the .agce file format, and can be imported to any Service Virtualization Server.

Export All Exports all agent configurations on the selected server. The file is saved in the .agce file format, and can be imported to any Service Virtualization Server.

Enables you to select an exported agent configuration file stored on the file system. The file is saved in the .agce file format, and can be imported to any Service Virtualization Server.

If the configuration file you are importing contains multiple configurations, you can select which configurations you want to import.

If you choose to import an agent configuration that is identical to a configuration that already exists on your server, you can choose to overwrite your existing configuration, or create a new, additional configuration.

Agent State The current status of the agent. Values include Running, Not Running.
Test Configuration link Tests the configuration based on the settings you select. If Service Virtualization identifies any problems in your configuration, the details are displayed.

Is Enabled

Turns the agent on and off.
Name Enter a name for the configuration or accept the default name.
Use SSL Enables SSL over TCP/IP. If enabled, you must provide certificate file and password details.

Enable SSL Client Authentication

Changes the SSL handshake between a client and a virtual service. It doesn't have any impact on the SSL handshake between the virtual service and a real service.

When checked, the HTTP agent (which has SSL enabled) requests an SSL client certificate from the client invoking a virtual service. This can be useful where you have multiple SSL client certificates in the Credential Store, and you want a virtual service to authenticate to the real service with the same certificate that the client is using, since this can change the behavior of the real service.

Note: This additional SSL handshake step has some performance overhead and is disabled by default.

Certificate File

The path to the server side certificate file, in P12 format, that is to be used by the gateway agent during an SSL handshake.

The certificate is used as the server certificate on the listening port if the Use SSL option is enabled. It is bound to the port during startup of the agent.

Note: When remotely configuring a Service Virtualization Server's agent from the Designer, make sure that the path to the certificate is valid on the server machine on which the agent will run.

If the Certificate File field is left empty and the Use SSL option is selected, then the agent will use the certificate bound to the specified port in Windows.

Certificate Password The password used to access the certificate file specified in the Certificate File field.


The port of the Service Virtualization Server used by the agent to deploy virtual services.

Timeout The period of time the agent waits before stopping attempts to communicate with the real service.
External URI The URI under which the agent is visible to client applications. This is used, for example when the machine is behind a firewall and the client can see only the firewall which forwards all requests to the agent. It may be left empty.

Unknown Endpoint Requests

Determines how to respond to requests when there is no service deployed that matches the URL path provided.

Includes the following options:

  • Return HTTP 404 Error.
  • Forward to URL: Requests are forwarded to the specified URL path.

    Use this option if you are not able to reconfigure clients on a service basis (i.e. by changing the endpoint of each service to a virtual service), and all of your HTTP(S) services reside on a single host.

Use another proxy server to communicate with real services

Enables you to configure proxy chaining. You can forward the HTTP(S) communication between the HTTP(S) Gateway agent and the real service through an additional proxy. If it is not set, the system default proxy server is used.

Click Settings to open the Proxy Settings dialog box. For details, see Proxy Settings dialog box.

Back to top