TestRail
FREE
By raygorodskij
Updated a year ago

TestRail API Documentation

TestRail helps you manage and track your software testing efforts and organize your QA department.

Learn more about this API
POSTaddResult
POSTaddResultForCase
POSTaddResults
POSTaddResultsForCases
POSTclosePlan
POSTcloseRun
POSTcreateCase
POSTcreateNewConfiguration
POSTcreateNewConfigurationGroup
POSTcreatePlan
POSTcreatePlanEntry
POSTcreateProject
POSTcreateSection
POSTcreateTestRun
POSTcreateTestSuite
POSTcreatesMilestone
POSTdeleteCase
POSTdeleteConfig
POSTdeleteConfigGroup
POSTdeleteMilestone
POSTdeletePlan
POSTdeletePlanEntry
POSTdeleteProject
POSTdeleteRun
POSTdeleteSection
POSTdeleteTestSuit
POSTgetAllCaseFields
POSTgetAllCaseTypes
POSTgetAllPriorities
POSTgetCase
POSTgetCases
POSTgetMilestone
POSTgetMilestones
POSTgetPlan
POSTgetPlans
POSTgetProject
POSTgetProjectConfigs
POSTgetProjects
POSTgetResultFields
POSTgetResults
POSTgetResultsForCase
POSTgetResultsForRun
POSTgetRun
POSTgetRuns
POSTgetSection
POSTgetSections
POSTgetStatuses
POSTgetTemplates
POSTgetTest
POSTgetTestSuite
POSTgetTestSuitesForProject
POSTgetTests
POSTgetUser
POSTgetUserByEmail
POSTgetUsers
POSTupdateCase
POSTupdateConfig
POSTupdateConfigGroup
POSTupdateMilestone
POSTupdatePlan
POSTupdatePlanEntry
POSTupdateProject
POSTupdateSection
POSTupdateTestRun
POSTupdateTestSuite
POSTupdateCase

Updates an existing test case (partial updates are supported, i.e. you can submit and update specific fields only).

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
apiKeyCREDENTIALS
REQUIREDYour API Key.Also you can use account password.
appNameCREDENTIALS
REQUIREDYour app name. Example - rapidtest.testrail.io
titleSTRING
REQUIREDThe title of the test case (required)
caseIdNUMBER
REQUIREDThe ID of the test case
usernameCREDENTIALS
REQUIREDYour username.
Optional Parameters
refsLIST
OPTIONALList of references/requirements.
customFieldsARRAY
OPTIONALCustom fields are supported as well and must be submitted with their system name, prefixed with 'custom_'.See more in readme.
priorityIdNUMBER
OPTIONALThe ID of the case priority.
milestoneIdNUMBER
OPTIONALThe ID of the milestone to link to the test case.
typeIdNUMBER
OPTIONALThe ID of the case type.
templateIdNUMBER
OPTIONALThe ID of the template (field layout) (requires TestRail 5.2 or later).
estimateSTRING
OPTIONALThe estimate, e.g. `30s` or `1m 45s`.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication