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
POSTaddResultForCase

Adds a new test result, comment or assigns a test (for a test run and case combination). It's recommended to use addresultsfor_cases instead if you plan to add results for multiple test cases.See more in readme.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
apiKeyCREDENTIALS
REQUIREDYour API Key.Also you can use account password.
runIdSTRING
REQUIREDThe ID of the test run.
caseIdSTRING
REQUIREDThe ID of the case run.
appNameCREDENTIALS
REQUIREDYour app name. Example - rapidtest.testrail.io
usernameCREDENTIALS
REQUIREDYour username.
Optional Parameters
defectsLIST
OPTIONALList of defects to link to the test result.
customFieldsARRAY
OPTIONALCustom fields are supported as well and must be submitted with their system name, prefixed with 'custom_'.See more in readme.
versionSTRING
OPTIONALThe version or build you tested against.
statusIdNUMBER
OPTIONALYou can get a full list of system and custom statuses via getStatuses.
commentSTRING
OPTIONALThe comment / description for the test result.
elapsedSTRING
OPTIONALThe time it took to execute the test, e.g. `30s` or `1m 45s`
assignedToIdSTRING
OPTIONALThe ID of a user the test should be assigned to.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication