TestRail source
Use the TestRail source connector to connect to the TestRail API.
Setup
Before you begin, make sure you have:
- A TestRail instance URL (for example,
https://yourcompany.testrail.io) - A TestRail user (email/username)
- A TestRail API key for that user
Authentication
This connector authenticates to TestRail using HTTP Basic Auth:
- Username: your TestRail username (often an email address)
- Password: your TestRail API key
During connection validation, the connector calls the TestRail API endpoint:
GET {base_url}/index.php?/api/v2/get_case_types
If the credentials are invalid or the instance URL is incorrect, validation will fail.
Configuration
| Field | Type | Required | Description |
|---|---|---|---|
base_url | string | ✅ | Base URL of your TestRail instance (for example, https://yourcompany.testrail.io). Trailing slashes are allowed. |
username | string | ✅ | TestRail username used for Basic Auth (often an email). |
api_key | string | ✅ | TestRail API key used as the Basic Auth password. |
Streams
This connector is currently in development.
- Catalog discovery currently returns an empty catalog.
- Extraction is not yet implemented.
As a result, no streams are available yet.