API: Introduction
TestRail's API can be used to integrate TestRail with various tools, frameworks and third-party applications. For example, many customers use the API to integrate their automated tests and submit test results to TestRail. The API can be used for various other tasks as well and you can find a small list of examples below.
The API is HTTP-based and can thus be used from virtually any framework, programming language and tool. Submitting data to TestRail via the API is done via simple POST requests. Requesting data is done through GET requests. All responses from the API are returned in JSON format.
The API is a separate module that you can download and add to a local TestRail installation. The API can also be activated for TestRail Hosted accounts on request. Please note that the API is rate limited for TestRail Hosted, so if you plan to submit many concurrent requests to the API, a local installation might work better (just contact us if you have any questions about this).
Some typical scenarios the API can be used for:
- Submit test results from automated tests
- Synchronize test cases between different systems
- Create test runs and plans programmatically
- Query information for integrations