REST APIs

NLG-GeneralSettings-RestAPI

URLs

The URLs panel displays the end points to access the NeoLoad REST APIs:

Port configuration

By default, the NeoLoad Controller embeds a REST API server that listens on port 7400.

The port can be customized in configuration file controller.properties, section [RESTAPIs].

[RESTAPIs]
port=<portNumber>

Encryption configuration

Client/server communications can be secured using SSL encryption. To enable SSL encryption, edit the controller.properties file, section [RESTAPIs], key issecured and set the value to true.

[RESTAPIs]
issecured=true
keystore.encryptedPassword=<password>

By default, a keystore contains a self-signed certificate used for encryption. This keystore is named dataexchange.keystore and is located in the user directory: Neotys\NeoLoad\<version>\conf. This keystore is unique per NeoLoad installation and it is generated the first time NeoLoad is launched.

To use a certificate signed by a certification authority, you can specify your own keystore, containing the end entity certificate to encrypt the communication. To specify a different keystore, you need to replace the file named dataexchange.keystore in the Neotys\NeoLoad\<version>\conf directory, and specify the encrypted password in file controller.properties, section [RESTAPIs], key keystore.encryptedPassword. The value provided for key keystore.encryptedPassword needs to be encrypted using the password-scrambler tool. For more information about Password-Scrambler, see How do I use the Password Scrambler tool?.

Identification

The Identification panel enables you to manage the client's identification. By default, when the checkbox is disabled, no identification is performed at General level but identification can be defined at Project level, see REST APIs for more information. If identification is disabled both at General level and at Project level, then the server accepts all client connections.