• Installs:
  • Today: 0
  • All Time: 0
Developer:userraygorodskij

TestRail API Package

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

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
Discussions
See All
Readme

TestRail

TestRail Package

TestRail helps you manage and track your software testing efforts and organize your QA department. Its intuitive web-based user interface makes it easy to create test cases, manage test runs and coordinate your entire testing process.

How to get credentials:

  1. Register on the www.gurock.com
  2. After registration, create api key in account settings
  3. After creation api key,API can be enabled in the administration area in TestRail under Administration > Site Settings > API
  4. You can get appName from url.For example rapidtest from url - https:\/\/rapidtest.testrail.io

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

TestRail.getCase

Use the following API method to request details about test case.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
caseIdNumberThe ID of the test case.

TestRail.getCases

Returns a list of test cases for a test suite or specific section in a test suite.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project.
suiteIdNumberThe ID of the test suite (optional if the project is operating in single suite mode).
sectionIdNumberThe ID of the section (optional).
createdAfterDatePickerOnly return test cases created after this date.
createdBeforeDatePickerOnly return test cases created before this date.
createdByListList of creators (user IDs) to filter by.
milestoneIdListList of milestone IDs to filter by (not available if the milestone field is disabled for the project).
priorityIdListList of priority IDs to filter by.
typeIdListList of case type IDs to filter by.
templateIdListList of template IDs to filter by.(requires TestRail 5.2 or later)
updatedAfterDatePickerOnly return test cases updated after this date.
updatedBeforeDatePickerOnly return test cases updated before this date.
updatedByListList of users who updated test cases to filter by.

TestRail.createCase

Creates a new test case.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
sectionIdNumberThe ID of the section the test case should be added to.
titleStringThe title of the test case (required)
templateIdNumberThe ID of the template (field layout) (requires TestRail 5.2 or later).
typeIdNumberThe ID of the case type.
estimateStringThe estimate, e.g. 30s or 1m 45s.
priorityIdNumberThe ID of the case priority.
milestoneIdNumberThe ID of the milestone to link to the test case.
refsListList of references/requirements.
customFieldsArrayCustom fields are supported as well and must be submitted with their system name, prefixed with 'custom_'.
customField example
{
    "custom_preconds": "These are the preconditions for a test case"
}
    "custom_steps_separated": [
        {
            "content": "Step 1",
            "expected": "Expected Result 1"
        },
        {
            "content": "Step 2",
            "expected": "Expected Result 2"
        }
    ]

TestRail.updateCase

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

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
caseIdNumberThe ID of the test case
titleStringThe title of the test case (required)
templateIdNumberThe ID of the template (field layout) (requires TestRail 5.2 or later).
typeIdNumberThe ID of the case type.
estimateStringThe estimate, e.g. 30s or 1m 45s.
priorityIdNumberThe ID of the case priority.
milestoneIdNumberThe ID of the milestone to link to the test case.
refsListList of references/requirements.
customFieldsArrayCustom fields are supported as well and must be submitted with their system name, prefixed with 'custom_'.
customFields example
    "custom_preconds": "These are the preconditions for a test case"
    "custom_steps_separated": [
        {
            "content": "Step 1",
            "expected": "Expected Result 1"
        },
        {
            "content": "Step 2",
            "expected": "Expected Result 2"
        }
    ]

TestRail.deleteCase

Deletes an existing test case.Please note: Deleting a test case cannot be undone and also permanently deletes all test results in active test runs (i.e. test runs that haven't been closed (archived) yet).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
caseIdNumberThe ID of the test case.

TestRail.getAllCaseFields

Returns a list of available test case custom fields.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.

TestRail.getAllCaseTypes

Returns a list of available case types.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.

TestRail.getProjectConfigs

Returns a list of available configurations, grouped by configuration groups (requires TestRail 3.1 or later).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project.

TestRail.createNewConfigurationGroup

Creates a new configuration group (requires TestRail 5.2 or later).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project the configuration group should be added to.
nameStringThe name of the configuration group (required).

TestRail.createNewConfiguration

Creates a new configuration (requires TestRail 5.2 or later).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
configGroupIdNumberThe ID of the configuration group the configuration should be added to.
nameStringThe name of the configuration (required).

TestRail.updateConfig

Updates an existing configuration (requires TestRail 5.2 or later).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
configIdNumberThe ID of the configuration.
nameStringThe name of the configuration.

TestRail.updateConfigGroup

Updates an existing configuration group (requires TestRail 5.2 or later).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
configGroupIdNumberThe ID of the configuration group.
nameStringThe name of the configuration group.

TestRail.deleteConfigGroup

Deletes an existing configuration group and its configurations (requires TestRail 5.2 or later).Please note: Deleting a configuration group cannot be undone and also permanently deletes all configurations in this group. It does not, however, affect closed test plans/runs, or active test plans/runs unless they are updated.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
configGroupIdNumberThe ID of the configuration group.

TestRail.deleteConfig

Deletes an existing configuration (requires TestRail 5.2 or later).Please note: Deleting a configuration cannot be undone. It does not, however, affect closed test plans/runs, or active test plans/runs unless they are updated.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
configIdNumberThe ID of the configuration.

TestRail.getMilestone

Returns an existing milestone.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
milestoneIdNumberThe ID of the milestone.

TestRail.getMilestones

Returns the list of milestones for a project.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project.
isCompletedSelect1 to return completed milestones only. 0 to return open (active/upcoming) milestones only (available since TestRail 4.0).
isStartedSelect1 to return started milestones only. 0 to return upcoming milestones only (available since TestRail 5.3).

TestRail.createsMilestone

Creates a new milestone.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project the milestone should be added to.
nameStringThe name of the milestone (required).
descriptionStringThe description of the milestone.
dueOnDatePickerThe due date of the milestone.
parentIdNumberThe ID of the parent milestone, if any (for sub-milestones) (available since TestRail 5.3).
startOnStringThe scheduled start date of the milestone.

TestRail.updateMilestone

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

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
milestoneIdNumberThe ID of the milestone.
isCompletedSelectTrue if a milestone is considered completed and false otherwise.
isStartedSelectTrue if a milestone is considered started and false otherwise.
parentIdStringThe ID of the parent milestone, if any (for sub-milestones) (available since TestRail 5.3).
startOnStringThe scheduled start date of the milestone.

TestRail.deleteMilestone

Deletes an existing milestone.Please note: Deleting a milestone cannot be undone.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
milestoneIdNumberThe ID of the milestone.

TestRail.getPlan

Returns an existing test plan.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
planIdNumberThe ID of the test plan.

TestRail.getPlans

Returns a list of test plans for a project.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project.
createdAfterDatePickerOnly return test plans created after this date.
createdBeforeDatePickerOnly return test plans created before this date.
createdByListList of creators (user IDs) to filter by.
isCompletedSelect1 to return completed test plans only. 0 to return active test plans only.
limitNumberLimit the result to :limit test plans.
offsetNumberUse :offset to skip records.
milestoneIdListList of milestone IDs to filter by.

TestRail.createPlan

Creates a new test plan.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project the test plan should be added to.
nameStringThe name of the test plan (required).
descriptionStringThe description of the test plan.
milestoneIdStringThe ID of the milestone to link to the test plan.
entriesJSONAn json array of objects describing the test runs of the plan.
entries example
    "entries": [
        { 
            "suite_id": 1,
            "name": "Custom run name",
            "assignedto_id": 1 // ID of the assignee
        },
        { 
            "suite_id": 1,
            "include_all": false, // Custom selection
            "case_ids": [1,2,3,5]
        }
    ]

Starting with TestRail 3.1, add_plan also supports configurations:

"entries": [
       {
           "suite_id": 1,
           "include_all": true,
           "config_ids": [1, 2, 4, 5, 6],
           "runs": [
               {
                   "include_all": false,
                   "case_ids": [1, 2, 3],
                   "assignedto_id": 1,
                   "config_ids": [2, 5]
               },
               {
                   "include_all": false,
                   "case_ids": [1, 2, 3, 5, 8],
                   "assignedto_id": 2,
                   "config_ids": [2, 6]
               }

               ..
           ]
       }
   ]

This will effectively create several test runs per test plan entry, similar to how you can manage test plans and configurations with TestRail's user interface. Please refer below for additional details.

TestRail.createPlanEntry

Adds one or more new test runs to a test plan.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
planIdNumberThe ID of the project the test plan should be added to.
suitIdNumberThe ID of the test suite for the test run(s).
nameStringThe name of the test run.
descriptionStringThe description of the test run(s) (requires TestRail 5.2 or later).
assignedtoIdNumberThe ID of the user the test run(s) should be assigned to.
includeAllSelectTrue for including all test cases of the test suite and false for a custom case selection (default: true).
caseIdsListAn array of case IDs for the custom case selection.
configIdsListAn array of configuration IDs used for the test runs of the test plan entry (requires TestRail 3.1 or later).
runsJSONAn array of configuration IDs used for the test runs of the test plan entry (requires TestRail 3.1 or later).
entries example
    "entries": [
        { 
            "suite_id": 1,
            "name": "Custom run name",
            "assignedto_id": 1 // ID of the assignee
        },
        { 
            "suite_id": 1,
            "include_all": false, // Custom selection
            "case_ids": [1,2,3,5]
        }
    ]

Starting with TestRail 3.1, add_plan also supports configurations:

"entries": [
       {
           "suite_id": 1,
           "include_all": true,
           "config_ids": [1, 2, 4, 5, 6],
           "runs": [
               {
                   "include_all": false,
                   "case_ids": [1, 2, 3],
                   "assignedto_id": 1,
                   "config_ids": [2, 5]
               },
               {
                   "include_all": false,
                   "case_ids": [1, 2, 3, 5, 8],
                   "assignedto_id": 2,
                   "config_ids": [2, 6]
               }

               ..
           ]
       }
   ]

This will effectively create several test runs per test plan entry, similar to how you can manage test plans and configurations with TestRail's user interface. Please refer below for additional details.

TestRail.updatePlan

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

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
planIdNumberThe ID of the project the test plan should be added to.
nameStringThe name of the test run.
descriptionStringThe description of the test run(s) (requires TestRail 5.2 or later).
milestoneIdStringThe ID of the milestone to link to the test plan.
entriesJSONAn json array of objects describing the test runs of the plan.
entries example
    "entries": [
        { 
            "suite_id": 1,
            "name": "Custom run name",
            "assignedto_id": 1 // ID of the assignee
        },
        { 
            "suite_id": 1,
            "include_all": false, // Custom selection
            "case_ids": [1,2,3,5]
        }
    ]

Starting with TestRail 3.1, add_plan also supports configurations:

"entries": [
       {
           "suite_id": 1,
           "include_all": true,
           "config_ids": [1, 2, 4, 5, 6],
           "runs": [
               {
                   "include_all": false,
                   "case_ids": [1, 2, 3],
                   "assignedto_id": 1,
                   "config_ids": [2, 5]
               },
               {
                   "include_all": false,
                   "case_ids": [1, 2, 3, 5, 8],
                   "assignedto_id": 2,
                   "config_ids": [2, 6]
               }

               ..
           ]
       }
   ]

This will effectively create several test runs per test plan entry, similar to how you can manage test plans and configurations with TestRail's user interface. Please refer below for additional details.

TestRail.updatePlanEntry

Updates one or more existing test runs in a plan (partial updates are supported, i.e. you can submit and update specific fields only).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
planIdNumberThe ID of the project the test plan should be added to.
entryIdStringThe ID of the test plan entry (note: not the test run ID)
nameStringThe name of the test run.
descriptionStringThe description of the test run(s) (requires TestRail 5.2 or later).
assignedtoIdNumberThe ID of the user the test run(s) should be assigned to.
includeAllSelectTrue for including all test cases of the test suite and false for a custom case selection (default: true)
caseIdsListAn array of case IDs for the custom case selection.

TestRail.closePlan

Closes an existing test plan and archives its test runs & results.Please note: Closing a test plan cannot be undone.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
planIdNumberThe ID of the plan.

TestRail.deletePlan

Deletes an existing test plan.Please note: Deleting a test plan cannot be undone and also permanently deletes all test runs & results of the test plan.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
planIdNumberThe ID of the plan.

TestRail.deletePlanEntry

Deletes one or more existing test runs from a plan.Please note: Deleting a test run from a plan cannot be undone and also permanently deletes all related test results.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
planIdNumberThe ID of the plan.
entryIdStringThe ID of the test plan entry (note: not the test run ID).

TestRail.getAllPriorities

Returns a list of available priorities.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.

TestRail.getProject

Returns an existing project.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdStringThe ID of the project.

TestRail.getProjects

Returns the list of available projects.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
isCompletedSelect1 to return completed projects only. 0 to return active projects only.

TestRail.createProject

Creates a new project (admin status required).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
nameStringThe name of the project (required).
announcementStringThe description of the project.
showAnnouncementSelectTrue if the announcement should be displayed on the project's overview page and false otherwise.
suiteModeNumberThe suite mode of the project (1 for single suite mode, 2 for single suite + baselines, 3 for multiple suites) (added with TestRail 4.0).

TestRail.updateProject

Updates an existing project (admin status required; partial updates are supported, i.e. you can submit and update specific fields only).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe name of the project (required).
isCompletedSelectSpecifies whether a project is considered completed or not.

TestRail.deleteProject

Deletes an existing project (admin status required).Please note: Deleting a project cannot be undone and also permanently deletes all test suites & cases, test runs & results and everything else that is part of the project.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdStringThe ID of the project.

TestRail.getResults

Returns a list of test results for a test.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
testIdStringThe ID of the test.
limitNumberLimit the result to .
offsetNumberUse :offset to skip records.
statusIdListList of status IDs to filter by.

TestRail.getResultsForCase

Returns a list of test results for a test run and case combination.

The difference to get_results is that this method expects a test run + test case instead of a test. In TestRail, tests are part of a test run and the test cases are part of the related test suite. So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run. You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status. Please also see TestRail's getting started guide for more details about the differences between test cases and tests.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run.
caseIdStringThe ID of the test case
limitNumberLimit the result to :limit test plans.
offsetNumberUse :offset to skip records.
statusIdListList of status IDs to filter by.

TestRail.getResultsForRun

Returns a list of test results for a test run.Requires TestRail 4.0 or later.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run.
createdAfterDatePickerOnly return test results created after this date.
limitNumberLimit the result to :limit test plans.
offsetNumberUse :offset to skip records.
statusIdListList of status IDs to filter by.
createdBeforeDatePickerOnly return test results created before this date.
createdByListList of creators (user IDs) to filter by.

TestRail.addResults

Adds one or more new test results, comments or assigns one or more tests. Ideal for test automation to bulk-add multiple test results in one step.This method expects an array of test results (via the 'results' field, please see below). Each test result must specify the test ID and can pass in the same fields as add_result, namely all test related system and custom fields.Please note that all referenced tests must belong to the same test run.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run the results should be added to.
resultJsonStructureListList of the json results objects.
result example
        {
            "test_id": 101,
            "status_id": 5,
            "comment": "This test failed",
            "defects": "TR-7"
        }

See more here.

TestRail.addResultsForCases

Adds one or more new test results, comments or assigns one or more tests (using the case IDs). Ideal for test automation to bulk-add multiple test results in one step.This method expects an array of test results (via the 'results' field, please see below). Each test result must specify the test case ID and can pass in the same fields as add_result, namely all test related system and custom fields. The difference to add_results is that this method expects test case IDs instead of test IDs. Please see addResultForCase for details. Please note that all referenced tests must belong to the same test run.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run the results should be added to.
resultJsonStructureListList of the json results objects.
structure example
        {
            "case_id": 1,
            "status_id": 5,
            "comment": "This test failed",
            "defects": "TR-7"
        }

See more here.

TestRail.addResult

Adds a new test result, comment or assigns a test. It's recommended to use add_results instead if you plan to add results for multiple tests.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
testIdStringThe ID of the test.
statusIdNumberYou can get a full list of system and custom statuses via getStatuses.
commentStringThe comment / description for the test result.
versionStringThe version or build you tested against.
elapsedStringThe time it took to execute the test, e.g. 30s or 1m 45s
defectsListList of defects to link to the test result.
assignedToIdStringThe ID of a user the test should be assigned to.
customFieldsArrayCustom fields are supported as well and must be submitted with their system name, prefixed with 'custom_'.See more here.

TestRail.addResultForCase

Adds a new test result, comment or assigns a test (for a test run and case combination). It's recommended to use add_results_for_cases instead if you plan to add results for multiple test cases.The difference to add_result is that this method expects a test run + test case instead of a test. In TestRail, tests are part of a test run and the test cases are part of the related test suite. So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run. You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status. Please also see TestRail's getting started guide for more details about the differences between test cases and tests.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run.
caseIdStringThe ID of the case run.
statusIdNumberYou can get a full list of system and custom statuses via getStatuses.
commentStringThe comment / description for the test result.
versionStringThe version or build you tested against.
elapsedStringThe time it took to execute the test, e.g. 30s or 1m 45s
defectsListList of defects to link to the test result.
assignedToIdStringThe ID of a user the test should be assigned to.
customFieldsArrayCustom fields are supported as well and must be submitted with their system name, prefixed with 'custom_'.See more here.

TestRail.getResultFields

Returns a list of available test result custom fields.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.

TestRail.getRun

Returns an existing test run. Please see getTests for the list of included tests in this run.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run.

TestRail.getRuns

Returns a list of test runs for a project. Only returns those test runs that are not part of a test plan (please see get_plans/get_plan for this).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project.
createdAfterDatePickerOnly return test runs created after this date.
createdBeforeDatePickerOnly return test runs created before this date.
createdByListList of creators (user IDs) to filter by.
milestoneIdListList of milestone IDs to filter by (not available if the milestone field is disabled for the project).
isCompletedBoolean1 to return completed test runs only. 0 to return active test runs only.
limitNumberLimit the result to.
offsetNumberUse :offset to skip records.
suiteIdStringThe ID of the test suite.

TestRail.createTestRun

Creates a new test run.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdNumberThe ID of the project.
suiteIdNumberThe ID of the test suite for the test run (optional if the project is operating in single suite mode, required otherwise).
nameStringThe name of the test run.
descriptionStringThe description of the test run.
milestoneIdStringThe ID of the milestone to link to the test run.
assignedToIdNumberThe ID of the user the test run should be assigned to.
includeAllSelectTrue for including all test cases of the test suite and false for a custom case selection (default: true).
caseIdsListAn array of case IDs for the custom case selection.

TestRail.updateTestRun

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

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdNumberThe ID of the test run.
nameStringThe name of the test run.
descriptionStringThe description of the test run.
milestoneIdStringThe ID of the milestone to link to the test run.
includeAllSelectTrue for including all test cases of the test suite and false for a custom case selection (default: true).
caseIdsListAn array of case IDs for the custom case selection.

TestRail.closeRun

Closes an existing test run and archives its tests & results.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run.

TestRail.deleteRun

Deletes an existing test run.Please note: Deleting a test run cannot be undone and also permanently deletes all tests & results of the test run.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run.

TestRail.getSection

Returns an existing section.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
sectionIdStringThe ID of the section.

TestRail.getSections

Returns a list of sections for a project and test suite.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdStringThe ID of the project.
suiteIdStringThe ID of the test suite (optional if the project is operating in single suite mode).

TestRail.createSection

Creates a new section.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdStringThe ID of the project.
descriptionStringThe description of the section (added with TestRail 4.0).
suiteIdNumberThe ID of the test suite (ignored if the project is operating in single suite mode, required otherwise).
parentIdNumberThe ID of the parent section (to build section hierarchies).
nameStringThe name of the section (required).

TestRail.updateSection

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

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
sectionIdStringThe ID of the section.
descriptionStringThe description of the section (added with TestRail 4.0).
nameStringThe name of the section.

TestRail.deleteSection

Deletes an existing section.Please note: Deleting a section cannot be undone and also deletes all related test cases as well as active tests & results, i.e. tests & results that weren't closed (archived) yet.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
sectionIdStringThe ID of the section.

TestRail.getStatuses

Returns a list of available test statuses.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.

TestRail.getTestSuite

Returns an existing test suite.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
suiteIdStringThe ID of the test suite.

TestRail.getTestSuitesForProject

Returns a list of test suites for a project.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdStringThe ID of the project.

TestRail.createTestSuite

Creates a new test suite.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdStringThe ID of the project the test suite should be added to.
descriptionStringThe description of the test suite.
nameStringThe name of the test suite.

TestRail.updateTestSuite

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

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
suiteIdStringThe ID of the test suite.
descriptionStringThe description of the test suite.
nameStringThe name of the test suite.

TestRail.deleteTestSuit

Deletes an existing test suite.Please note: Deleting a test suite cannot be undone and also deletes all active test runs & results, i.e. test runs & results that weren't closed (archived) yet.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
suiteIdStringThe ID of the test suite.

TestRail.getTemplates

Returns a list of available templates (requires TestRail 5.2 or later).

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
projectIdStringThe ID of the project.

TestRail.getTest

Returns an existing test.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
testIdStringThe ID of the test.

TestRail.getTests

Returns a list of tests for a test run.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
runIdStringThe ID of the test run.
statusIdsListList of status IDs to filter by.

TestRail.getUser

Returns an existing user.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
userIdStringThe ID of the user.

TestRail.getUserByEmail

Returns an existing user by his/her email address.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
emailStringThe email address to get the user for.

TestRail.getUsers

Returns a list of users.

FieldTypeDescription
appNamecredentialsYour app name. Example - rapidtest
usernamecredentialsYour username.
apiKeycredentialsYour API Key.Also you can use account password.
x
circle
TestRail
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view