Troubleshooting

If requests fail, run zero doctor check-connector --env-name TESTRAIL_TOKEN or zero doctor check-connector --url https://$TESTRAIL_INSTANCE.testrail.io/index.php?/api/v2/get_projects --method GET

How to Use

All examples assume TESTRAIL_EMAIL, TESTRAIL_TOKEN (API key), and TESTRAIL_INSTANCE (the subdomain before .testrail.io) are set. TestRail uses HTTP Basic auth — email as username, API key as password.

Base URL: https://$TESTRAIL_INSTANCE.testrail.io/index.php?/api/v2/

Pass credentials with -u "$TESTRAIL_EMAIL:$TESTRAIL_TOKEN". Self-hosted instances use a different domain; set TESTRAIL_INSTANCE appropriately if your team runs TestRail Server.

1. List Projects

curl -s "https://$TESTRAIL_INSTANCE.testrail.io/index.php?/api/v2/get_projects" -u "$TESTRAIL_EMAIL:$TESTRAIL_TOKEN" | jq '.projects[] | {id, name, suite_mode, is_completed}'

suite_mode: 1 = single suite, 2 = single suite + baselines, 3 = multiple suites.