Skip to content

Test management API

Check a TestRail, Zephyr Scale, Xray, or Azure Test Plans connection and browse its projects and suites.

These endpoints use the test management credentials saved in the project's settings. See Connect a test management tool.

systemType is testrail, zephyr, xray, or azure. Any other value returns 404. All endpoints need the platform:manage scope.

Check the connection

POST/api/projects/{projectId}/test-management/{systemType}/validateBearer or API key · platform:manage

Returns 200 with { "ok": true }, or { "ok": false, "message": "..." } when Certyn cannot connect.

List projects

GET/api/projects/{projectId}/test-management/{systemType}/projectsBearer or API key · platform:manage

List suites in a project

GET/api/projects/{projectId}/test-management/{systemType}/projects/{externalProjectId}/suitesBearer or API key · platform:manage

Missing or invalid saved credentials return 400.

To run an external suite, create a suite with kind: "external_suite": see the Suites API.

Example

curl -sS -H "X-API-Key: $CERTYN_API_KEY" \
  "https://api.certyn.io/api/projects/$PROJECT_ID/test-management/testrail/projects"