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
POSTcreatePlan

Creates a new test plan.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
nameSTRING
REQUIREDThe name of the test plan (required).
projectIdNUMBER
REQUIREDThe ID of the project the test plan should be added to.
appNameCREDENTIALS
REQUIREDYour app name. Example - rapidtest.testrail.io
apiKeyCREDENTIALS
REQUIREDYour API Key.Also you can use account password.
usernameCREDENTIALS
REQUIREDYour username.
Optional Parameters
milestoneIdSTRING
OPTIONALThe ID of the milestone to link to the test plan.
descriptionSTRING
OPTIONALThe description of the test plan.
entriesJSON
OPTIONALAn json array of objects describing the test runs of the plan.See more in readme.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication