REST APIs

URLs

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

• Data Exchange API, for more information, see the Data Exchange API User Guide
• Design API, for more information, see the Design API User Guide
• Runtime API, for more information, see the Runtime API User Guide
• Results API, for more information, see the Results API User Guide

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, identification is required at General level. If identification is disabled at General level, it still can be enabled for specific projects, 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.

• Information: If the identification is enabled at the general settings level, the API key will be required for any project you will open and even if no project is opened. That way, if for example the Create project method is called on the API, it will be secured by the API key generated with the activation of the identification.
  • To identify a client
  1. Check the Identification required option.
  2. Click the + button to create a new identification key entry.
  3. Enter the API key for the client you want to identify.
  • To remove a client identification
  1. Select the API key for the client you want to remove.
  2. Click the - button.