Skip to main content
The TestRail connector indexes test cases from your TestRail projects. Each case becomes one document, with its steps and expected results as text and a link back to the case in TestRail.

​
How it works

​
Before you begin

You need:
  • The URL of your TestRail site, such as https://example.testrail.io
  • A TestRail user that can read the projects you want to index
  • An API key for that user
  • TestRail’s API enabled for the site
  • An Onyx administrator account
See TestRail’s API accessibility documentation for enabling the API and generating a key.
The connector reads only what its TestRail user can read.

​
Configure Onyx

1

Open the TestRail connector

In Onyx, go to Admin Panel → Add Connector and select TestRail.
2

Create a credential

Enter the site URL in TestRail Base URL, the user’s login in TestRail Username, and the API key in TestRail API Key.Create a TestRail credential with a base URL, username and API key
3

Choose the projects

Give the connector a name. In Project IDs, enter a comma-separated list of TestRail project IDs, for example 1,2,3. Leave it empty to index every project the user can read.
4

Choose the access type

Public makes all indexed cases visible to every Onyx user. Private limits the connector to selected Onyx user groups, and is a paid feature: the Business and Enterprise tiers on Onyx Cloud, and the Enterprise Edition when self-hosted.
5

Connect and verify

Select Create Connector. Then open Admin Panel → Existing Connectors, select the connector, and confirm its first indexing attempt completes.

​
Advanced settings

​
Limits

The connector indexes no attachments, so it has no file-size cap.

​
Troubleshooting

Invalid or expired TestRail credentials (HTTP 401) means the username or API key is wrong, or the key has been revoked. Confirm the username is the user’s login and create a new API key. Also confirm the API is enabled in TestRail’s site settings.
Insufficient permissions to access TestRail resources (HTTP 403) means the user cannot read the projects being indexed. Grant it access in TestRail, or narrow Project IDs to the projects it can read.
Confirm the user can open it in TestRail, and that its project ID is in Project IDs when that field is not empty. A case longer than Skip Document Character Limit is skipped and logged; raise the limit to index it.
Lower Cases Page Size so each API call returns less, and raise REQUEST_TIMEOUT_SECONDS if TestRail is slow to answer.