TestRail

Upload an attachment file to a test case. Use this to add screenshots, documents, or other files to test cases for documentation or evidence. Maximum ...

Upload an attachment file to a test plan. Maximum file size is 256MB. Returns the attachment_id.

Upload an attachment file to a test plan entry. Maximum file size is 256MB. Returns the attachment_id.

Upload an attachment file to a test result. Maximum file size is 256MB. Returns the attachment_id.

Upload an attachment file to a test run. Maximum file size is 256MB. Returns the attachment_id.

Add a test result for a specific test. Use this to record test execution results including status, comments, elapsed time, and defects. Returns the cr...

Add a test result for a specific case within a test run. Returns the created result details.

Add multiple test results for a test run in a single API call (bulk operation). More efficient than adding results one by one. Returns array of create...

Add multiple test results for cases within a test run in a single API call (bulk operation). More efficient than adding results one by one. Returns ar...

Close a test plan. Closed plans cannot be modified or executed.

Close a test run. Closed runs cannot be modified or executed.

Delete an attachment from Testrail. CAUTION: Deletion is permanent and cannot be undone. All file data will be removed.

Delete a test case from Testrail. CAUTION: Deletion is permanent and cannot be undone. All case data will be removed.

Delete a milestone from Testrail. CAUTION: Deletion is permanent and cannot be undone.

Delete a test plan from Testrail. CAUTION: Deletion is permanent and cannot be undone.

Delete a test result from Testrail. CAUTION: Deletion is permanent and cannot be undone.

Delete a test run from Testrail. CAUTION: Deletion is permanent and cannot be undone.

Delete a section from Testrail. CAUTION: Deletion is permanent and cannot be undone.

Delete a shared step from Testrail. CAUTION: Deletion is permanent and cannot be undone.

Delete a suite from Testrail. CAUTION: Deletion is permanent and cannot be undone.

Download an attachment file from Testrail. Returns the file content as binary data. If save_path is provided, saves the file to disk. Otherwise return...

Fetch detailed information about a specific BDD by ID. Returns complete BDD details including scenario steps and conditions.

Fetch detailed information about a specific test case by ID. Returns complete case details including title, type, priority, status, and custom fields.

Fetch detailed information about test cases from a specific project or suite. Use this tool to analyze or track specific cases by 'project_id' and 'su...

Retrieve configuration settings for a given project in Testrail. This is useful for understanding or modifying how a project organizes test environmen...

Access datasets used in a specific Testrail project. Useful for test automation teams needing to verify or adjust test data sets. Returns dataset deta...

Fetch detailed information about a specific milestone by ID. Returns complete milestone details including name, description, and due date.

Get a list of project milestones within Testrail. Ideal for project managers tracking progress or deadlines. This returns milestone names, deadlines, ...

Fetch detailed information about a specific test plan by ID. Returns complete plan details including name, description, milestones, and entries.

Fetch test plans associated with a specific project in Testrail. Use for planning or monitoring test activities within a project. Provides details lik...

Fetch detailed information about a specific project by ID. Returns complete project details including name, description, and configuration.

Fetch detailed information about a specific test run by ID. Returns complete run details including name, description, milestone, and assigned user.

Fetch all test runs associated with a specific project in TestRail. Ideal for tracking progress and execution status of ongoing test runs. It provides...

Access detailed information on all tests within a specific test run. Use this tool to evaluate test results and performance within individual runs. Re...

Fetch detailed information about a specific section by ID. Returns complete section details including name, description, and parent section.

Retrieve a list of all sections within a test suite for a specific project. This is helpful for organizing test cases and structuring test suites. It ...

Fetch detailed information about a specific shared step by ID. Returns complete shared step details including content and steps.

Fetch detailed information about a specific suite by ID. Returns complete suite details including name, description, and type.

List all test suites within your TestRail project. Use this tool to get an overview of different test suites available for your project. It returns su...

Get a list of all test templates available in a specific project. This tool is useful for setting up consistent test structures. It provides details o...

Fetch detailed information about a specific test by ID. Returns complete test details including case information, status, and assigned user.

Fetch detailed information about a specific user by ID. Returns complete user details including name, email, and role.

Fetch user information by email address. Returns complete user details including name, ID, and role.

Retrieve a list of all attachments associated with a specific test case. Use this when you need to see files, screenshots, or documents attached to a ...

Retrieve a list of all attachments associated with a test plan. Returns attachment metadata including filename, size, upload date, and attachment_id.

Retrieve a list of all attachments associated with a test plan entry. Returns attachment metadata.

Retrieve a list of all attachments associated with a test run. Returns attachment metadata.

Retrieve a list of all attachments associated with a test's results. Returns attachment metadata.

Retrieve a list of all BDDs (Behavior-Driven Development scenarios) for a specific project. Returns BDD metadata.

Fetch a list of all customized case fields in your Testrail account. Use when you need to see existing fields to manage or create cases. Returns an ar...

Retrieve all available test case statuses from the Testrail system. Use this to understand or report on the status of test cases within your projects....

Access a list of all case types configured in Testrail. Utilize this when setting up new test cases and need to choose an appropriate type. This retur...

Retrieve a list of all groups for a specific project. Returns group metadata including name and member count.

Retrieve a list of all labels used in a specific project. Returns label names and usage counts.

List all test priorities configured within Testrail. Utilize this to categorize and prioritize test cases efficiently. Returns priority details such a...

Retrieve a comprehensive list of all projects in Testrail. Perfect for administrators needing an overview of active and archived projects. This will r...

Retrieve a list of all available reports for a specific project. Returns report metadata including name, type, and description.

Retrieve a list of all available test result fields in TestRail. Use this tool when you need to understand the structure of results for reporting purp...

Retrieve a list of all test results for a specific test. Returns result details including status, comment, elapsed time, and execution date.

Retrieve a list of all test results for a specific case within a test run. Returns result details.

Retrieve a list of all test results for a specific test run. Returns result details for all tests in the run.

Obtain a list of all user roles defined in your TestRail instance. This is useful for managing user permissions and understanding role-based access co...

Retrieve a list of all shared steps for a specific project. Returns shared step metadata including name and content.

Access a list of all users registered in your TestRail account. Ideal for user management and monitoring account access. It returns user details, supp...

Retrieve a list of all variables for a specific project. Returns variable metadata including name and value.

Execute a report and return the results. Returns report data based on the report configuration.

Update an existing test result. Provide result_id and any fields to change. Only specified fields will be updated.

Create a new test case or update an existing one. Use this to add new test cases to your test suite or modify existing cases. For create: provide sect...

Create a new milestone or update an existing one. For create: provide project_id and name (required). For update: provide id and any fields to change.

Create a new test plan or update an existing one. For create: provide project_id and name (required). For update: provide id and any fields to change.

Create a new test run or update an existing one. For create: provide project_id and name (required). For update: provide id and any fields to change.

Create a new section or update an existing one. For create: provide project_id, suite_id, and name (required). For update: provide id and any fields t...

Create a new shared step or update an existing one. For create: provide project_id and title (required). For update: provide id and any fields to chan...

Create a new suite or update an existing one. For create: provide project_id and name (required). For update: provide id and any fields to change.