API Documentation

MERV exposes a REST API under the base path /api/v1. This page mirrors the public Swagger groups for test reporting and project APIs. Account, organization, billing, and related management APIs are available in the MERV app only and are not listed here.

← Merv-Server launch guide

Swagger UI (source of truth): https://merv.online/swagger-ui.html · Local: http://localhost:7777/swagger-ui.html

Authentication

Authenticate with a Bearer JWT from the MERV app, or an API key header when calling report APIs from CI.
Create and manage credentials in the MERV app — those management endpoints are not part of this public reference.

Test Suite Management

Base path: /api/v1/testsuites

GET/api/v1/testsuitesGet all test suites
POST/api/v1/testsuitesCreate a new test suite
GET/api/v1/testsuites/alias/{alias}Get test suite ID by alias
POST/api/v1/testsuites/transfer-testcasesTransfer test cases between suites
POST/api/v1/testsuites/with-alias-confirmationCreate test suite with alias confirmation
GET/api/v1/testsuites/{id}Get test suite by ID
PUT/api/v1/testsuites/{id}Update test suite
PATCH/api/v1/testsuites/{id}Partially update test suite
DELETE/api/v1/testsuites/{id}Delete test suite
POST/api/v1/testsuites/{id}/deactivateMake test suite inactive
POST/api/v1/testsuites/{id}/restoreRestore inactive test suite
PATCH/api/v1/testsuites/{id}/statusUpdate test suite status
PUT/api/v1/testsuites/{id}/with-alias-confirmationUpdate test suite with alias confirmation
GET/api/v1/testsuites/{id}/failure-bug-tracksList failure bug tracks for a test suite
PUT/api/v1/testsuites/{id}/failure-bug-tracksTrack a bug for a failure reason group
DELETE/api/v1/testsuites/{id}/failure-bug-tracksRemove a failure bug track

Test Case Management

GET/api/v1/testcasesGet all test cases
POST/api/v1/testcasesCreate a new test case
POST/api/v1/testcases/deactivateBulk deactivate test cases
GET/api/v1/testcases/suite/{testSuiteId}Get test cases by test suite ID
GET/api/v1/testcases/{id}Get test case by ID
PUT/api/v1/testcases/{id}Update test case
DELETE/api/v1/testcases/{id}Permanently delete test case
PUT/api/v1/testcases/{id}/statusUpdate test case status
PUT/api/v1/testcases/{id}/finishFinish test case
PUT/api/v1/testcases/{id}/restartRestart test case
POST/api/v1/testcases/{id}/deactivateDeactivate (soft-delete) test case
POST/api/v1/testcases/{id}/restoreRestore inactive test case

Test Step Management

GET/api/v1/teststepsGet all test steps
POST/api/v1/teststepsCreate a new test step
POST/api/v1/teststeps/with-filesCreate a new test step with attached files
GET/api/v1/teststeps/testcase/{testCaseId}Get test steps by test case ID
GET/api/v1/teststeps/{id}Get test step by ID
PUT/api/v1/teststeps/{id}Update test step
PATCH/api/v1/teststeps/{id}Partially update test step
DELETE/api/v1/teststeps/{id}Delete test step
POST/api/v1/teststeps/{id}/screenshotUpload screenshot for test step
GET/api/v1/teststeps/{id}/screenshotGet screenshot for test step

File Attachment Management

POST/api/v1/teststeps/{testStepId}/filesUpload file to test step
GET/api/v1/teststeps/{testStepId}/filesGet all files for test step
GET/api/v1/teststeps/{testStepId}/files/{fileType}Get files by type for test step
DELETE/api/v1/teststeps/{testStepId}/filesDelete all files for test step
GET/api/v1/files/{fileId}/downloadDownload file
PUT/api/v1/files/{fileId}/descriptionUpdate file description
DELETE/api/v1/files/{fileId}Delete file

Hierarchy Management

GET/api/v1/hierarchyGet all hierarchies
POST/api/v1/hierarchyCreate a new hierarchy
GET/api/v1/hierarchy/default-projectGet default project
GET/api/v1/hierarchy/{id}Get hierarchy by ID
PUT/api/v1/hierarchy/{id}Update hierarchy name
DELETE/api/v1/hierarchy/{id}Delete hierarchy
GET/api/v1/hierarchy/{id}/childrenGet child hierarchies
GET/api/v1/hierarchy/{id}/kpi-snapshotsGet KPI snapshots for a project

Failure Bug Tracking

GET/api/v1/failure-bug-tracksList tracked failure bugs

Example: Get test cases by suite

GET /api/v1/testcases/suite/39c6ac17-1930-4278-8e9e-cb5a1822c795
Authorization: Bearer <access_token>

← Documentation Forum / Defects →