NeoLoad Web API

NeoLoad provides a set of API calls based on the REST API integration framework. This allows you to remotely retrieve test statistics and manage test execution. For instance, you can:

  • Perform periodic reporting in a third-party program. For example, if you want to know how many tests were launched by a specific user within a given time frame.

  • Perform automatic testing in the context of continuous integration.

  • Feed a third-party program with values of your load tests.

To use the NeoLoad Web API, all requests must be made over HTTPS. If a request is not authenticated by an access token, it fails. Note that the API responses return as JSON format in the HTTP response, including errors.

Connect to the API

Connection to the API depends on your deployment type:

  • When NeoLoad Web is deployed as a SaaS, the URL is https://neoload-api.saas.neotys.com/explore/

  • When NeoLoad Web is deployed on-premise, the URL is http://<server name>:8080/explore. If the default location has been modified, refer to Installation or contact your Administrator to find the port.

In this section

Check out the following topics on the NeoLoad Web API: