API

Tricentis NeoLoad provides comprehensive APIs to automate testing workflows, integrate with CI/CD pipelines, and extend functionality. The APIs enable programmatic control over test design, execution, and results analysis.

This section covers the Tricentis NeoLoad APIs:

• API authentication - Secure API access using token-based authorization.

• REST API - Automate test operations and integrate with external systems.

• Data Exchange API - Send external data to Tricentis NeoLoad during test execution.

• Data Format Extension API - Create custom encoders and decoders for proprietary protocols.

• Custom Action API - Build custom actions to extend Tricentis NeoLoad functionality.

• JavaScript Action API - Write JavaScript-based custom actions with access to runtime context, variables, and virtual user data.

• Design API - Programmatically create and configure projects, recordings, and test designs.

• Runtime API - Control test execution programmatically, including starting, stopping, and monitoring tests.

• Results API - Retrieve and analyze test results programmatically.

Common use cases

You can use the Tricentis NeoLoad APIs for:

• Automating test execution in CI/CD pipelines.

• Programmatic test design and configuration.

• Sending external monitoring data into test results during execution.

• Retrieving and analyzing test results.

• Building custom actions and protocol extensions.

• Integrating with monitoring and alerting systems.

What's next

Start by reviewing API authentication to learn how to secure your API access. Then explore the specific API that fits your use case.