Projects
RabbitQA has two unrelated resources called "project", owned by different services and reached through different prefixes. Choose the one that matches the module you are working with.
| Resource | Prefix | Used by |
|---|---|---|
| Test management project | /tmt/company/api/v1/projects | TestPilot, CaseWriter, Accessibility and the shared test repository |
| Automation project | /autorunner/api/v1/projects | AutoRunner (the UI calls these Sources) |
Both are scoped by X-Workspace-Id.
not
The organization-level container is the workspace, not the project. See Workspaces.
Test management projects
Base path: https://api.rabbitqa.com/tmt/company/api/v1/projects
curl https://api.rabbitqa.com/tmt/company/api/v1/projects \
-H "Authorization: Bearer $TOKEN" \
-H "X-Workspace-Id: 91"
| Method | Path | Purpose |
|---|---|---|
GET | /projects | List projects |
POST | /projects | Create a project |
POST | /projects/copy | Copy an existing project |
GET | /projects/{projectId} | Retrieve one |
PUT | /projects/{projectId} | Update |
DELETE | /projects/{projectId} | Delete |
GET | /projects/{projectId}/status | Project status summary |
Contents of a project
| Method | Path | Purpose |
|---|---|---|
GET | /projects/{projectId}/testCases | Test cases in the project |
POST | /projects/{projectId}/testCases | Add test cases |
DELETE | /projects/{projectId}/testCases | Remove test cases |
GET | /projects/{projectId}/testSets | Test sets in the project |
POST | /projects/{projectId}/testSets | Add test sets |
DELETE | /projects/{projectId}/testSets | Remove test sets |
POST | /projects/{projectId}/testTrees | Build the test tree |
POST | /projects/{projectId}/testResults | Results for the project |
POST | /projects/{projectId}/testResults/detailed | Results with step detail |
GET | /projects/{projectId}/testCases/{testCaseId}/testResult | Latest result for one case |
Scheduled project operations live under /tmt/company/api/v1/projects/schedules.
AutoRunner automation projects
Base path: https://api.rabbitqa.com/autorunner/api/v1/projects
These represent a source-controlled automation codebase. In the AutoRunner interface they appear as Sources.
| Method | Path | Purpose |
|---|---|---|
GET | /projects | List automation projects |
GET | /projects/summary | Summary rows for listing screens |
GET | /projects/health-summary | Health indicators per project |
GET | /projects/workspace-sources | Sources available in the workspace |
GET | /projects/{id} | Retrieve one |
GET | /projects/{id}/context | Resolved project context |
POST | /projects | Create |
PUT | /projects/{id} | Update |
PATCH | /projects/{id}/scm | Change the source-control binding |
PATCH | /projects/{id}/name | Rename |
PATCH | /projects/{id}/branch | Change the tracked branch |
DELETE | /projects/{id} | Delete |
GET | /projects/types | Supported project types |
POST | /projects/detect-framework | Detect the test framework in a repository |
Related endpoints on the same base path cover project settings, members, templates and Postman collections.
See also
- Test Cases — the case resource shared by TestPilot and CaseWriter
- Test Runs — executing and reporting on tests