Test runs

Test runs are an important component for tracking and managing the testing process. Our REST API provides comprehensive endpoints for handling test runs, enabling you to automate and streamline your testing workflow. With these endpoints, in a project, you can access list of test runs, create new test runs, and add test results to test runs.

Note: For a comprehensive list of default Enum values (such as Priority, State, and Type of Test Case), refer to the System-defined Enum values page.

Get test runs list

GET /api/v2/projects/{project_id}/test-runs

Invoking this API will fetch the list of test runs in a project associated with your username and access key. You will need the id of the project to access its list of test runs.

When requesting a list of test runs using the REST API, you can apply filters to get only the ones you want. Attributes-based filtering allows for selecting test cases by matching one or more attribute values passed as query parameters. The following table lists the available attributes.

API query name	Example value	Description
`closed_before`	date `YYYY-MM-DD` or `DD-MM-YYYY`	Only return test runs closed before this date.
`closed_after`	date `YYYY-MM-DD` or `DD-MM-YYYY`	Only return test runs closed after this date.
`created_before`	date `YYYY-MM-DD` or `DD-MM-YYYY`	Only return test runs created before this date.
`created_after`	date `YYYY-MM-DD` or `DD-MM-YYYY`	Only return test runs created after this date.
`test_plan_id`	string (e.g., `TP-1`)	Return all test runs linked to this test plan. (Only single values are allowed)
`assignee`	string (e.g., `john@email.com`)	Return all test runs assigned to this user. (Multiple values can be passed, comma-separated)
`include_closed`	Boolean (`true` or `false`)	Determines whether to include closed test runs in the response. `true` will include both active and closed test runs, while `false` will only include active test runs.
`run_state`	string (e.g., `new`)	Return all test runs with this state. (Multiple values can be passed, comma-separated). Possible values: `new`, `under_review`, `in_progress`, `rejected`, `done`, `closed`

When you provide multiple values for the same query parameter, any one value must match the specified attributes. This means that an OR operator is applied within the query parameter. On the other hand, if you include multiple attribute values across different parameters, an AND operator is used across these different parameters. This requires all conditions to be met for a match.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects/PR-1575/test-runs?run_state=rejected,closed&created_before=2024-11-01&closed_after=2024-11-15&test_plan_id=TP-1&assignee=abc@email.com

project_id^* String

Identifier of the project.

Response attributes `200 OK` `json`

Response

{
  "success": true,
  "test_runs": [
    {
      "active_state": "active",
      "run_state": "done",
      "assignee": "john@email.com",
      "created_at": "2023-11-28T13:33:26.000Z",
      "identifier": "TR-78282",
      "name": "sample build #2",
      "project_id": "PR-1",
      "test_cases_count": 5,
      "configurations": [101, 102, 103],
      "include_closed": true
    }
  ]
}

active_state String

State of the test run.
run_state String

State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
assignee String

Email of the test run assignee.
created_at String

The time the test run was created on BrowserStack servers.
identifier String

Identifier of the test run.
Show 4 more
name String

Name of the test run.
project_id String

Identifier of the project.
test_cases_count Integer

Count of number of test cases.
configurations Array

A list of unique identifiers, each specifying a distinct combination of operating system, browser, and device.

Create a test run

POST /api/v2/projects/{project_id}/test-runs

Invoking this API will create test runs programmatically, providing flexibility and automation in managing your test cycles. To create a test run, you will need the id of the project in which the test run should be created. If you need to link this test run to a test plan, you will require the id of that test plan.

You can apply filters to get only the test cases you want. Attributes-based filtering allows for selecting test cases by matching one or more attribute values passed as query parameters. When you provide multiple values for the same query parameter, any one value must match the specified attributes. This means that an OR operator applies within the query parameter. On the other hand, if you include multiple attribute values across different parameters, an AND operator is used across these different parameters. This requires all conditions to be met for a match.

By default, the filter_test_cases filters are applied globally across the entire project. To restrict filtering to only the test cases within specified folders, set filter_scope to "within_folders".

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/PR-1/test-runs

project_id^* String

Identifier of the project.

Request body

Request Body

{
  "test_run": {
    "name": "Test Run-29/11/2023",
    "description": "check the performance of the test run",
    "run_state": "new_run",
    "assignee": "john@email.com",
    "test_case_assignee": "john@email.com",
    "tags": [
      "Regression"
    ],
    "issues": ["TASK-309"],
    "issue_tracker": {
      "name": "jira",
      "host": "https://demo.atlassian.net"
    },
    "configurations": [101, 102, 103],
    "test_plan_id" : "TP-20",
    "sub_test_plan_id": "STP-5",
    "test_cases": ["TC-1", "TC-3"],
    "folder_ids": [34, 54, 64],
    "include_all": false,
    "filter_test_cases": {
      "status": ["active", "draft"],
      "priority": ["medium","low" ],
      "case_type": ["regression", "smoke"],
      "owner": ["randomUser@email.com", "uniqueUser@email.com"],
      "tags": ["test", "regression"],
      "custom_fields": {
        "my_custom_field": ["sample_value_1", "sample_value_2"],
        "test": ["a1", "a2"],
        "estimate": [10, 20]
      }
    }
  }
}

name String

Name of the test run.
description String

Brief information about the test run.
run_state String

State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
assignee String

Email of the test run assignee.
test_case_assignee String

Email of the test case assignee.
Show 12 more
tags Array

Descriptive labels or keywords linked to the test run.
issues Array

List of the linked Jira, Asana or Azure issues.
issue_tracker Object

Ensures that issue IDs are correctly associated with their respective issue tracking tool, facilitating accurate linking and management.

▶ SHOW VALUES
- name String
  
  Specifies the issue tracking system to integrate with. Set to one of jira (Jira), azure (Azure DevOps), asana (Asana), or clickup (ClickUp).
- host String
  
  The base URL of your issue tracking system. For Jira Cloud instances, this typically follows the format https://your-domain.atlassian.net.
configurations Array

A list of unique identifiers, each specifying a distinct combination of operating system, browser, and device. This optional parameter is required only if a test run includes configurations.
configuration_map Array

Optional. Assign explicit configurations to specific test cases. This mapping overrides the configurations array. The API applies exact mappings instead of generating a cartesian product. Unmapped test cases receive no configuration. Use the configurations array to set a fallback for unmapped test cases.

▶ SHOW VALUES
- test_case_id Array or String
  
  One or more test case identifiers to assign configurations to. Accepts a single test case ID as a string (e.g., "TC-1103745") or multiple IDs as an array (e.g., ["TC-11", "TC-15"]).
- configuration_ids Array
  
  List of configuration IDs to assign to the specified test case(s).
test_plan_id String

Identifier of the test plan.
sub_test_plan_id String

Identifier of the Sub Test Plan to link to this test run (e.g., STP-5). Mutually exclusive with test_plan_id. Only one can be provided.
test_cases Array

List of test case IDs.
folder_ids Array

Identifiers of each folder.
include_all Boolean

If the value is true, all test cases in the project are added to the test run.
filter_scope String

Determines the scope for filter_test_cases. global applies filters project-wide. within_folders limits filters to the specified folder_ids. Defaults to global.
filter_test_cases Object

Use this object if you want to filter test cases before appending to the test run.

▶ SHOW VALUES
- status Array
  
  Indicates the status of the test case.
- priority Array
  
  Priority of the test case.
- case_type Array
  
  Type of test case.
- owner Array
  
  Email of the owner of test case.
- tags Array
  
  Descriptive labels or keywords linked to the test case.
- custom_fields Object
  
  Key-value pairs where the key is the custom field name and the value is an array of accepted values to filter by.

`filter_scope` value	Result
Omitted / `global`	Filters apply across the entire project. All matching test cases are included regardless of which folder they belong to. (Existing behavior — unchanged.)
`within_folders`	Filters apply only within the specified `folder_ids`. Only test cases that are both inside those folders and match the filter criteria are included.

Note:

filter_scope only takes effect when both folder_ids and filter_test_cases are present in the request. If either is absent, filter_scope has no effect.

When include_all: true is set, it takes precedence over filter_scope and all test cases from the project are included.

Note: test_plan_id and sub_test_plan_id are mutually exclusive. Providing both in the same request will return an error. Additionally, passing a parent Test Plan identifier (e.g., TP-20) in the sub_test_plan_id field will also return an error.

Response attributes `200 OK` `json`

Response

{
  "success": true,
  "testrun": {
      "active_state": "active",
      "run_state": "new_run",
      "created_at": "2023-11-29T06:26:22.215Z",
      "description": "check the performance of the test run",
      "identifier": "TR-78527",
      "name": "Test Run-29/11/2023",
      "assignee": "john@email.com",
      "project_id": "PR-1",
      "tags": ["performance"],
      "test_cases_count": 1,
      "updated_at": "2023-11-29T06:26:22.215Z",
      }
  }

success Boolean

API call is executed successfully.
active_state String

State of the test run.
run_state String

State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
created_at String

The time at which the test run was created on BrowserStack servers.
description String

Brief information about the test run.
Show 7 more
identifier String

Identifier of the test run.
name String

Name of the test run.
assignee String

Email of the test run assignee.
project_id String

Identifier of the Project.
tags Array

Descriptive labels or keywords linked to the test run.
test_cases_count Integer

Count of number of test cases.
updated_at String

The time at which the test run was updated on BrowserStack servers.

Clone a test run

POST /api/v2/projects/{project_id}/test-runs/{test_run_id}/clone

This endpoint creates a new test run by cloning an existing one. It accepts the same options as the UI’s Clone dialog. Use it to start a regression cycle from an earlier run without re-selecting test cases manually.

The response returns as soon as BrowserStack creates the cloned run. It includes the run’s metadata, such as its name, run state, tags, configurations, and any issues or attachments carried over from the source.

The per-test-case mappings come later. BrowserStack populates them in the background, shortly after it returns the response. If you call GET /test-runs/{test_run_id}/test-cases immediately after cloning, the response may list zero test cases until that background work finishes. The wait is usually under a second.

Note:

You cannot clone an automated source run.

The cloned run does not carry over the source run’s test plan associations.

The cloned run inherits the dynamic-run flag from the source. BrowserStack does not re-evaluate the underlying filter at clone time.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/PR-1/test-runs/TR-45/clone

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the source test run to clone.

Request body

All fields are optional, so an empty body {} clones the run with the Clone dialog defaults. Those defaults carry over all test cases, tags, and assignees. They also name the new run after the source, with ` - Copy` appended.

Request Body

{
  "test_case_selection": "by_results",
  "statuses": ["failed", "blocked"],
  "copy_tc_assignee": true,
  "copy_tags": true,
  "copy_issues": false,
  "name": "Sprint 24 - Regression Re-Run"
}

test_case_selection String

Which test cases from the source run to include in the clone. One of all or by_results. Defaults to all.
statuses Array

Required when test_case_selection is by_results. Selects test cases by their latest result status on the source run.
copy_tc_assignee Boolean

Carry over per-test-case assignees from the source run. Defaults to true.
copy_tags Boolean

Carry over the source run’s tags to the cloned run. Defaults to true.
copy_issues Boolean

Carry over linked Jira issues from the source run. Defaults to false.
name String

Name for the new test run. Defaults to the source run’s name with - Copy appended.

Note: Send statuses only when test_case_selection is by_results. The API selects test cases whose latest result on the source run matches one of the listed statuses.

Response attributes `200 OK` `json`

Response

{
  "success": true,
  "test_run": {
    "identifier": "TR-99",
    "name": "Sprint 24 - Regression Re-Run",
    "run_state": "new_run",
    "active_state": "active",
    "description": "",
    "assignee": "john@email.com",
    "tags": ["Regression"],
    "configurations": [],
    "test_case_summary": {
      "untested": 12,
      "passed": 0,
      "retest": 0,
      "failed": 0,
      "blocked": 0,
      "skipped": 0,
      "in_progress": 0
    },
    "links": {
      "self": "/api/v2/projects/PR-1/test-runs/TR-99",
      "test_cases": "/api/v2/projects/PR-1/test-runs/TR-99/test-cases"
    }
  }
}

success Boolean

Indicates whether the API call succeeded.
test_run Object

The cloned test run and its attributes.

▶ SHOW VALUES
- identifier String
  
  Identifier of the cloned test run.
- name String
  
  Name of the cloned test run.
- run_state String
  
  State of the cloned test run.
- active_state String
  
  Active state of the cloned test run.
- description String
  
  Brief information about the cloned test run.
- assignee String
  
  Email of the cloned test run assignee.
- tags Array
  
  Descriptive labels or keywords on the cloned test run.
- configurations Array
  
  A list of configuration identifiers linked to the cloned test run.
- test_case_summary Object
  
  Count of test cases under the cloned run by status. Every carried-over test case resets to untested at clone time, so the non-untested counts start at zero.
  
  ▶ SHOW VALUES
  - untested Integer
    
    The number of test cases in the cloned run that are untested. Every carried-over test case starts as untested.
  - passed Integer
    
    The number of test cases marked passed. This count is 0 in a newly cloned run.
  - retest Integer
    
    The number of test cases marked for retest. This count is 0 in a newly cloned run.
  - failed Integer
    
    The number of test cases marked failed. This count is 0 in a newly cloned run.
  - blocked Integer
    
    The number of test cases marked blocked. This count is 0 in a newly cloned run.
  - skipped Integer
    
    The number of test cases marked skipped. This count is 0 in a newly cloned run.
  - in_progress Integer
    
    The number of test cases in progress. This count is 0 in a newly cloned run.
- links Object
  
  API endpoint URLs for the cloned test run and its test cases.
  
  ▶ SHOW VALUES
  - self String
    
    API endpoint URL of the cloned test run.
  - test_cases String
    
    API endpoint URL for the test cases in the cloned test run.

The test_case_summary counts show how many test cases will be populated under the new run, all reset to untested. The source run’s pass and fail results do not carry over to the cloned run.

Error responses

Code	Reason
`400`	The request body failed validation. Examples: an unknown `test_case_selection` value, a missing `statuses` array when `test_case_selection` is `by_results`, or an unknown status name.
`401`	Authentication is missing or invalid.
`403`	The authenticated user does not have permission to read the source run or to write to the project.
`404`	The source test run does not exist, is an automated run, or belongs to a different project.

Get test run details

GET /api/v2/projects/{project_id}/test-runs/{test_run_id}

Invoking this API will fetch the details of test cases linked to a test run. You will need the id of the project and id of the test run to access the details of test cases. The sample request has PR-1 and TR-78527 as placeholders representing project ID and test run ID, respectively.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects/PR-1/test-runs/TR-78527

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Response attributes `200 OK` `json`

Response

{
   "success":true,
   "test_run":{
      "active_state":"active",
      "run_state":"new_run",
      "created_at":"2023-11-29T06:26:22.215Z",
      "description":"",
      "identifier":"TR-78527",
      "name":"Test Run-29/11/2023",
      "assignee":"john@email.com",
      "project_id":"PR-1",
      "configurations":[101, 102, 103],
      "test_cases":[
         {
            "assignee":"john@email.com",
            "case_type":"other",
            "priority":"High",
            "status":"Active",
            "description":"",
            "identifier":"TC-1",
            "name":"Assign tags to user and then re-open the modal",
            "latest_status":"Passed",
            "configuration_id":101,
            "latest_result_id":108767
         }
      ],
      "links":{
         "test_cases":"/api/v2/projects/PR-1/test-runs/TR-78527/test-cases"
      },
      "tags":["ttt"],
      "test_cases_count":3,
      "updated_at":"2023-11-29T06:26:22.215Z",
      "passed_count":1,
      "failed_count":1,
      "customstatus_count":1,
      "overall_progress":{
         "untested":0,
         "passed":2,
         "retest":0,
         "failed":0,
         "blocked":0,
         "skipped":0,
         "in_progress":0
      }
   }
}

active_state String

State of the test run.
run_state String

State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
created_at String

The time the test run was created on BrowserStack servers.
description String

Brief information about the test run.
identifier String

Identifier of the test run.
Show 9 more
name String

Name of the test run.
assignee String

Email of the test run assignee.
project_id String

Identifier of the project.
configurations Array

A list of unique identifiers, each specifying a distinct combination of operating system, browser, and device.
test_cases Array

This list has information about a specific test case.

▶ SHOW VALUES
- assignee String
  
  Email of the test run assignee.
- case_type String
  
  Gives the type of test case.
- priority String
  
  Gives the priority of the test case.
- status String
  
  Gives the state of the test case.
- description String
  
  Brief information about the test case.
- name String
  
  Gives the title of the test case.
- latest_status String
  
  Gives the status of the test case.
- latest_result_id integer
  
  The latest result id of the test case in the run.
- configuration_id Integer
  
  Unique identifier for a specific operating system, browser, and device configuration.
links String

Give the api endpoint url of the test case.
tags Array

Descriptive labels or keywords linked to the test case.
test_cases_count Object

Count of number of test cases.
overall_progress Object

This object provides a comprehensive summary of the test run’s overall status, including both system status (such as passed and failed) and any user-defined custom statuses.

Get test run details minified

GET /api/v2/projects/PR-1/test-runs/TR-5/test-cases?minify=true

This endpoint returns minified details for a specific test run. The response contains only essential fields for the test run, making it suitable for scenarios where you need a lightweight payload (for example, quick status checks or summary views).

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects/PR-75/test-runs/TR-152?minify=true

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Response attributes `200 OK` `json`

Response

{
   "success":true,
   "test_run":{
      "active_state":"active",
      "run_state":"new_run",
      "created_at":"2025-08-20T10:27:03.000Z",
      "updated_at":"2025-08-20T10:27:03.000Z",
      "description":"",
      "identifier":"TR-152",
      "name":"Test Run-20/08/2025",
      "assignee":"user@email.com",
      "project_id":"PR-75",
      "overall_progress":{
         
      },
      "tags":[
         
      ],
      "configurations":[
         
      ],
      "links":{
         "self":"/api/v1/projects/10075/test-runs/TR-152",
         "test_cases":"/api/v2/projects/PR-75/test-runs/TR-152/test-cases"
      }
   }
}

success Boolean

Indicates if the request was successful.
test_run Object

The test run object containing minified details.

▶ SHOW VALUES
- active_state String
  
  State of the test run.
- run_state String
  
  State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
- created_at String
  
  The time the test run was created on BrowserStack servers.
- updated_at String
  
  The time the test run was last updated on BrowserStack servers.
- description String
  
  Brief information about the test run.
- identifier String
  
  Unique identifier of the test run.
- name String
  
  Name of the test run.
- assignee String
  
  Email of the test run assignee.
- project_id String
  
  Unique identifier of the project.
- overall_progress Object
  
  This object provides a comprehensive summary of the test run’s overall status, including both system status (such as passed and failed) and any user-defined custom statuses.
- tags Array
  
  Descriptive labels or keywords linked to the test run.
- configurations Array
  
  A list of unique identifiers, each specifying a distinct combination of operating system, browser, and device.
- links Object
  
  API endpoint URLs related to the test run, such as self and test_cases.
  
  ▶ SHOW VALUES
  - self String
    
    API endpoint URL for the test run itself.
  - test_cases String
    
    API endpoint URL for the test cases in the test run.

Get test cases of a test run

GET /api/v2/projects/{project_id}/test-runs/{test_run_id}/test-cases

Invoking this API will fetch the details of all the test cases linked to a test run. You will need the id of the project and id of the test run to access the details of test cases. Using this endpoint, you can retrieve the first thirty test cases. This list is paginated; for more information, refer Pagination.

Each test case includes a source_project_id. For a shared test case, this is the project the test case was shared from. For a test case that is not shared, source_project_id matches project_id.

The sample request has PR-1 and TR-78527 as placeholders representing project ID and test run ID, respectively.
Use fetch_steps query parameter in the API to get test case steps. When the fetch_steps query parameter is used, the API returns the first 30 test case steps. Pagination is not supported for requests that include this parameter. The steps array is populated with step objects, each containing its own id and order.

Example: https://test-management.browserstack.com/api/v2/projects/PR-1/test-runs/TR-78527/test-cases?fetch_steps=true

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects/PR-1/test-runs/TR-78527/test-cases?p=1

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Response attributes `200 OK` `json`

Response

{
   "success":true,
   "info":{
      "page":1,
      "page_size":30,
      "count":94,
      "prev":null,
      "next":2
   },
   "test_cases":[
      {
         "case_type":"Destructive",
         "priority":"High",
         "status":"Active",
         "description":"Subject the password reset system to sustained high load over an extended period and monitor for any degradation in performance or stability issues. This test is important to ensure the system can maintain performance during extended periods of high usage.",
         "identifier":"TC-972133",
         "name":"Verify system stability during prolonged high load",
         "project_id":"PR-1",
         "source_project_id":"PR-9",
         "steps":[
            {
               "id":34001057,
               "order":1,
               "description":"Initiate a high-load scenario using the load testing tool, simulating a consistently high number of password reset requests over an extended period (e.g., 24 hours).",
               "result":"The system should accept and process reset requests consistently throughout the test period without significant degradation in performance."
            },
            {
               "id":34001061,
               "order":5,
               "description":"Regularly check the email sending process, measuring the time to generate, queue, and send recovery emails throughout the test period.",
               "result":"Email processing should keep pace with incoming requests, maintaining consistent performance (e.g., < 1 minute from request to email sent) throughout the test."
            }
         ],
         "latest_status":"untested",
         "latest_result_id":null,
         "assignee":null,
         "folder_path":[
            10456816
         ],
        "configuration_id": 44028850,
            "dataset": [
              {
                "variable": "col1",
                "row": "1"
              },
              {
                "variable": "col1",
                "row": "2"
              }
            ], 
        "created_at": "2025-09-03T11:20:52.000Z",
        "last_updated_at": "2025-09-03T11:29:34.000Z",
        "created_by": "user1@email.com",
        "last_updated_by": "user2@email.com",
      }
   ]
}

success Boolean

API call is executed successfully.
info Object

Additional pagination information.

▶ SHOW VALUES
- page Integer
  
  The current page being viewed displays a list of test cases.
- page_size Integer
  
  Number of test cases in the page.
- count Integer
  
  Total number of records across all pages.
- prev Integer
  
  Previous page number.
- next Integer
  
  Next page number.
test_cases Array

This list has information about a specific test case.

▶ SHOW VALUES
- case_type String
  
  Gives the type of test case.
- priority String
  
  Gives the priority of the test case.
- status String
  
  Gives the state of the test case.
- description String
  
  Brief information about the test case.
- identifier String
  
  Unique identifier of the test case.
- name String
  
  Gives the title of the test case.
- project_id String
  
  Unique identifier of the project that the test run belongs to.
- source_project_id String
  
  Unique identifier of the original project that a shared test case was shared from. For a test case that is not shared, this value matches the project_id.
- steps Array
  
  List of step objects for the test case, each representing an individual action and expected result.
  
  ▶ SHOW VALUES
  - id Integer
    
    Unique identifier for the step.
  - order Integer
    
    The sequence order of the step in the test case.
  - description String
    
    Detailed description of the step to be performed.
  - result String
    
    The expected outcome or result for the step.
- latest_status String
  
  Gives the status of the test case.
- latest_result_id String
  
  Gives the ID of the latest test result.
- assignee String
  
  Email of the test run assignee.
- folder_path Array
  
  It is a list of test case folder IDs, starting with the root folder at the top and ending with the last folder at the bottom.
- configuration_id Integer
  
  Unique identifier for the configuration used in the test case.
  
  ▶ SHOW VALUES
  - dataset Array
    
    List of dataset objects associated with the configuration.
    
    ▶ SHOW VALUES
    - variable String
      
      Name of the dataset variable.
    - row String
      
      Row value for the dataset variable.
- created_at String
  
  Timestamp (ISO 8601) when the test case was created.
- last_updated_at String
  
  Timestamp (ISO 8601) when the test case was last updated.
- created_by String
  
  Email of the user who created the test case.
- last_updated_by String
  
  Email of the user who last updated the test case.

Get test cases of a test run minified

GET /api/v2/projects/PR-75/test-runs/TR-152?minify=true

Invoking this API fetches only the essential fields of all the test cases linked to a test run, such as test case ID, description, title and the latest status. You will need the id of the project and id of the test run to access the details of test cases.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects/PR-1/test-runs/TR-5/test-cases?minify=true

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Response attributes `200 OK` `json`

Response

{
   "success":true,
   "info":{
      "page":1,
      "page_size":30,
      "count":1,
      "prev":null,
      "next":null
   },
   "test_cases":[
      {
         "description":"WINDOWS,Unknown - Edge,110",
         "identifier":"TC-98",
         "name":"Check whether the application has secure protocols like HTTPS.",
         "latest_status":"untested"
      }
   ]
}

success Boolean

API call is executed successfully.
info Object

Additional pagination information.

▶ SHOW VALUES
- page Integer
  
  The current page being viewed displays a list of test cases.
- page_size Integer
  
  Number of test cases in the page.
- count Integer
  
  Total number of records across all pages.
- prev Integer
  
  Previous page number.
- next Integer
  
  Next page number.
test_cases Array

List of minified test case objects for the test run.

▶ SHOW VALUES
- description String
  
  Brief information about the test case, such as configuration or environment.
- identifier String
  
  Unique identifier of the test case.
- name String
  
  Name of the test case.
- latest_status String
  
  The most recent status of the test case in the test run.

Update a test run (PATCH)

PATCH /api/v2/projects/{project_id}/test-runs/{test_run_id}/update

Use this API to update an existing test run. Unlike the POST method which requires all fields to be present, this PATCH endpoint only updates the fields that are provided in the request body. This allows for partial updates to a test run without needing to resend all the data. To update a test run, you will need both the id of the project (eg: PR-2134) and the id of the test run (eg: TR-2343) within that project.

Note:

To clear an array field (like tags or issues), you must send an empty array ([]) in the request body.

Omitting a field from the request body will leave that field unchanged.

The PATCH API endpoint is used to update specific fields. Include only the fields you wish to modify in the request body.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X PATCH https://test-management.browserstack.com/api/v2/projects/{project_id}/test-runs/{test_run_id}/update

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Request body

Request Body

{
  "test_run": {
    "name": "Test Run-29/11/2023",
    "run_state": "new_run",
    "tags": ["ttt"],
    "sub_test_plan_id": "STP-5",
    "configurations": [101, 102, 103],
    "configuration_map": [
      {
        "test_case_id": ["TC-11", "TC-15"],
        "configuration_ids": [231, 235]
      },
      {
        "test_case_id": "TC-1103745",
        "configuration_ids": [240]
      }
    ],
    "folder_ids": [34, 54, 64],
    "include_all": false,
    "filter_test_cases": {
      "status": ["active", "draft"],
      "priority": ["medium", "low"],
      "case_type": ["regression", "smoke"],
      "owner": ["randomUser@email.com", "uniqueUser@email.com"],
      "tags": ["test", "regression"]
    }
  }
}

name String

Name of the test run.
run_state String

State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
tags Array

Descriptive labels or keywords linked to the test run.
sub_test_plan_id String

Identifier of the Sub Test Plan to link (e.g., STP-5). Mutually exclusive with test_plan_id.
configurations Array

A list of unique identifiers, each specifying a distinct combination of operating system, browser, and device.
Show 4 more
configuration_map Array

Optional. Assign explicit configurations to specific test cases. This mapping overrides the configurations array. The API applies exact mappings instead of generating a cartesian product. Unmapped test cases receive no configuration. Use the configurations array to set a fallback for unmapped test cases.

▶ SHOW VALUES
- test_case_id Array or String
  
  One or more test case identifiers to assign configurations to. Accepts a single test case ID as a string (e.g., "TC-1103745") or multiple IDs as an array (e.g., ["TC-11", "TC-15"]).
- configuration_ids Array
  
  List of configuration IDs to assign to the specified test case(s).
folder_ids Array

Identifiers of each folder.
include_all Boolean

If the value is true, all test cases in the project are added to the test run.
filter_test_cases Object

Use this object if you want to filter test cases before appending to the test run.

▶ SHOW VALUES
- status Array
  
  Indicates the status of the test case.
- priority Array
  
  Priority of the test case.
- case_type Array
  
  Type of test case.
- owner Array
  
  Email of the owner of test case.
- tags Array
  
  Descriptive labels or keywords linked to the test case.

Response attributes `200 OK` `json`

Response

{
  "success": true,
  "testrun": {
    "name": "Test Run-29/11/2023",
    "run_state": "new",
    "tags": ["ttt"]
  }
}

success Boolean

API call is executed successfully.
name String

Name of the test run.
run_state String

State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
tags Array

Descriptive labels or keywords linked to the test run.

Update a test run (POST)

POST /api/v2/projects/{project_id}/test-runs/{test_run_id}/update

Invoking this API allows you to update test runs in a given project. When you update the test run, the new test cases in the update test run request will replace all the existing test cases. To update a test run, you will need both the id of the project (eg: PR-2134) and the id of the test run (eg: TR-2343) within that project.

Note: The POST API endpoint requires a complete request body. All listed parameters must be included in your Request Body, even if they have null or default values.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/{project_id}/test-runs/{test_run_id}/update

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Request body

Request Body

{
  "test_run": {
    "name": "Test Run-29/11/2023",
    "description": "gas",
    "run_state": "new_run",
    "assignee": "john@email.com",
    "test_case_assignee": "john@email.com"
    "tags": [
      "ttt"
    ],
    "issues": [
      "XYZ-1"
    ],
    "issue_tracker": {
      "name": "jira",
      "host": "https://demo.atlassian.net"
    },
    "test_plan_id" : "TP-20",
    "sub_test_plan_id": "STP-5",
    "configurations": [101, 102],
    "test_cases": ["TC-1", "TC-3"],
    "folder_ids": [34,54,64],
    "include_all": false,
    "filter_test_cases": {
      "status": ["active", "draft"],
      "priority": ["medium","low" ],
      "case_type": ["regression", "smoke"],
      "owner": ["randomUser@email.com", "uniqueUser@email.com"],
      "tags": ["test", "regression"]
  }
}

name^* String

Name of the test run.
description^* String

Brief information about the test run.
run_state^* String

State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
assignee^* String

Email of the test run assignee.
test_case_assignee^* String

Email of the test case assignee.
Show 11 more
tags^* Array

Descriptive labels or keywords linked to the test run.
issues^* Array

List of the linked Jira, Asana or Azure issues.
issue_tracker Object

Ensures that issue IDs are correctly associated with their respective issue tracking tool, facilitating accurate linking and management.

▶ SHOW VALUES
- name String
  
  Specifies the issue tracking system to integrate with. Set to one of jira (Jira), azure (Azure DevOps), asana (Asana), or clickup (ClickUp).
- host String
  
  The base URL of your issue tracking system. For Jira Cloud instances, this typically follows the format https://your-domain.atlassian.net.
test_plan_id String

Identifier of the test plan.
sub_test_plan_id String

Identifier of the Sub Test Plan to link (e.g., STP-5). Mutually exclusive with test_plan_id.
configurations^* Array

A list of unique identifiers, each specifying a distinct combination of operating system, browser, and device. This optional parameter is required only if a test run includes configurations.
configuration_map Array

Optional. Assign explicit configurations to specific test cases. This mapping overrides the configurations array. The API applies exact mappings instead of generating a cartesian product. Unmapped test cases receive no configuration. Use the configurations array to set a fallback for unmapped test cases.

▶ SHOW VALUES
- test_case_id Array or String
  
  One or more test case identifiers to assign configurations to. Accepts a single test case ID as a string (e.g., "TC-1103745") or multiple IDs as an array (e.g., ["TC-11", "TC-15"]).
- configuration_ids Array
  
  List of configuration IDs to assign to the specified test case(s).
test_cases^* Array

List of test case IDs.
folder_ids^* Array

Identifiers of each folder.
include_all Boolean

If the value is true, all test cases in the project are added to the test run.
filter_test_cases Object

Use this object if you want to filter test cases before appending to the test run.

▶ SHOW VALUES
- status Array
  
  Indicates the status of the test case.
- priority Array
  
  Priority of the test case.
- case_type Array
  
  Type of test case.
- owner Array
  
  Email of the owner of test case.
- tags Array
  
  Descriptive labels or keywords linked to the test case.

Response attributes `200 OK` `json`

Response

{
  "success": true,
  "testrun": {
    "active_state": "active",
    "run_state": "new_run",
    "created_at": "2023-11-29T06:26:22.215Z",
    "description": "gas",
    "identifier": "TR-78527",
    "name": "Test Run-29/11/2023",
    "assignee": "john@email.com",
    "project_id": "PR-1",
    "test_plan": {
      "identifier": "TP-20",
      "name": "Test plan6"
    },
    "tags": [
      "ttt"
    ],
    "issues": [
      "XYZ-1"
    ],
    "test_cases_count": 2,
    "updated_at": "2023-11-29T06:26:22.215Z"
  }
}

success Boolean

API call is executed successfully.
active_state String

State of the test run.
run_state String

State of the test run. The valid states are new_run, in_progress, under_review, rejected, done, and closed.
created_at String

The time at which the test run was created on BrowserStack servers.
description String

Brief information about the test run.
Show 9 more
identifier String

Identifier of the test run.
name String

Name of the test run.
assignee String

Email of the test run assignee.
project_id String

Identifier of the Project.
test_plan JSON Object

This list has information about a specific test plan.

▶ SHOW VALUES
- identifier String
  
  Unique identifier of the test plan.
- name String
  
  Name of the test plan.
tags Array

Descriptive labels or keywords linked to the test run.
issues Array

List of the linked Jira, Asana or Azure issues.
test_cases_count Integer

Count of number of test cases.
updated_at String

The time at which the test run was updated on BrowserStack servers.

Update assignee of test cases within a test run

POST /api/v2/projects/PR-5512/test-runs/TR-126509/assign

Invoking this API will update assignees of test cases within a test run. To do so, you will need the id of the project, the id of the test run (eg: TR-2343), the id of test cases, and the email of assignees.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/PR-5512/test-runs/TR-126509/assign

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Request body

Request Body

{
  "assign_to": [
    {
      "test_case_id": "TC-337204",
      "configuration_id": 2,
      "assignee": "john@email.com"
    },
    {
      "test_case_id": "TC-337205",
      "configuration_id": 1,
      "assignee": "randomUser@email.com"
    },
    {
      "test_case_id": "TC-337203",
      "configuration_id": 1,
      "assignee": "uniqueUser@email.com"
    }
  ]
}

test_case_id^* String

Test case ID whose assignee should be updated.
configuration_id Integer

Unique identifier for a specific operating system, browser, and device configuration. This optional parameter is required only if a test run includes configurations.
assignee^* String

Email of the assignee.

Response attributes `200 OK` `json`

Response

{
    "success": true
}

success Boolean

API call is executed successfully.

Add or remove test cases in a test run

PATCH /api/v2/projects/{project_id}/test-runs/{test_run_id}/test-cases

Use this API to add test cases to a test run or to remove test cases from it. Each request performs one operation, either add or remove. The execution results of the test cases that stay in the run are not affected.

To call this API, you need the id of the project and the id of the test run. Keep the PR- and TR- prefixes in both IDs. A bare numeric ID returns a not-found error. The test run must belong to the project you name in the path.

Send the operation inside a test_run object. Use add_test_cases to add test cases or remove_test_cases to remove them. Do not send both arrays in one request. Each entry pairs a test_case_ids array with the configuration_ids that the operation applies to. When an entry has no configuration_ids, the API targets only the test cases that carry no configuration.

To remove test cases under all their configurations synchronously, use Remove test cases from a test run by identifier.

To add or remove a shared test case, name its source project in the entry. Set source_project to the project identifier, such as PR-3265, or set source_project_id to the numeric project ID. Use one of the two fields, not both. Omit both fields for a test case that belongs to the test run’s own project.

When you remove test cases, set preserve_existing_results to true to keep the results of the test cases that remain. The field defaults to false.

Note:

Send exactly one of add_test_cases or remove_test_cases. An empty request returns operation_required. A request with both arrays returns only_one_operation_allowed.

A request can reference up to 300 unique test case IDs across all entries. A larger request returns max_test_cases_per_request_exceeded.

A test case ID cannot appear twice in the same operation, within one entry or across entries. A duplicate returns duplicate_test_case_id.

Every test case ID and configuration ID must be valid and accessible to you. The API rejects an invalid ID before it changes anything.

Adding a test case that is already in the run has no effect. Removing a test case that is not in the run has no effect either. The API skips these pairs instead of failing the request.

To add or remove a shared test case, you need access to its source project. The test case must be shared with the test run’s project.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X PATCH https://test-management.browserstack.com/api/v2/projects/{project_id}/test-runs/{test_run_id}/test-cases

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Request body

Both operations use the same fields. The parameter table after the first example applies to both.

Add test cases

The following request adds three test cases to the run. The first entry adds TC-101 and TC-102 under configurations 1 and 2. The second entry adds TC-103 with no configuration. The third entry adds a shared test case from project PR-3265.

Request Body

{
  "test_run": {
    "add_test_cases": [
      {
        "test_case_ids": ["TC-101", "TC-102"],
        "configuration_ids": [1, 2]
      },
      {
        "test_case_ids": ["TC-103"]
      },
      {
        "test_case_ids": ["TC-57"],
        "source_project": "PR-3265"
      }
    ]
  }
}

add_test_cases Array

Test cases to add to the test run. Each object lists one or more test case IDs in test_case_ids and the configurations to add them under. Omit configuration_ids to add the test cases with no configuration. Do not send this field together with remove_test_cases.

▶ SHOW VALUES
- test_case_ids Array
  
  One or more test case identifiers to add. For example, ["TC-101", "TC-102"]. A test case ID cannot appear twice in the same request.
- configuration_ids Array
  
  Configuration IDs to add the test cases under. Omit this field to add the test cases with no configuration.
- source_project String
  
  Project identifier of the source project, such as PR-3265, when the test cases are shared from another project. Omit this field for test cases that belong to the test run’s own project. Do not send this field together with source_project_id.
- source_project_id Integer
  
  Numeric ID of the source project when the test cases are shared from another project. Use this field or source_project, not both.
remove_test_cases Array

Test cases to remove from the test run. Each object lists one or more test case IDs in test_case_ids and the configurations to remove. Omit configuration_ids to remove only the entries that have no configuration. Do not send this field together with add_test_cases.

▶ SHOW VALUES
- test_case_ids Array
  
  One or more test case identifiers to remove. For example, ["TC-104", "TC-105"]. A test case ID cannot appear twice in the same request.
- configuration_ids Array
  
  Configuration IDs to remove for the test cases. Omit this field to remove only the entries that have no configuration.
- source_project String
  
  Project identifier of the source project, such as PR-3265, when the test cases are shared from another project. Omit this field for test cases that belong to the test run’s own project. Do not send this field together with source_project_id.
- source_project_id Integer
  
  Numeric ID of the source project when the test cases are shared from another project. Use this field or source_project, not both.
preserve_existing_results Boolean

When you remove test cases, set to true to keep the results of the test cases that remain in the run. Defaults to false.

Remove test cases

To remove test cases instead, send remove_test_cases with the same entry structure. The following request removes two test cases under configurations 1 and 2. It keeps the results of the test cases that remain.

Request Body

{
  "test_run": {
    "remove_test_cases": [
      {
        "test_case_ids": ["TC-104", "TC-105"],
        "configuration_ids": [1, 2]
      }
    ],
    "preserve_existing_results": true
  }
}

Response attributes `202 Accepted` `json`

The API validates the request, then runs the operation asynchronously. A 202 Accepted response confirms that the request passed validation and was queued. It does not confirm that every pair was applied. To check the outcome, see Confirm the changes.

Response

{
  "success": true,
  "async": true,
  "unique_id": "c6d0b247-3f5e-447a-91f8-a8f12848b8b9"
}

success Boolean

Indicates that the request passed validation and was accepted for processing.
async Boolean

Always true. The operation runs asynchronously after the request returns.
unique_id String

Unique identifier for this request.

Confirm the changes

The 202 response returns a unique_id that identifies your request. It does not report which test cases changed. The API does not send a completion callback.

To confirm what the run contains after the operation finishes, call Get test cases of a test run. The paginated response lists the test cases in the run with their configurations.

Adding a test case that is already in the run changes nothing. Removing a test case that is not in the run changes nothing either. So the run can end up with fewer changes than the number of pairs you sent.

Error responses

When validation fails, the API returns a single error object synchronously. The body names the failure in error and describes it in message. For the HTTP status codes this API can return, refer to Response status codes.

Response

{
  "success": false,
  "error": "invalid_test_case_id",
  "message": "invalid test_case_id (TC-123455): not found in project 1490"
}

Error code	Cause
`operation_required`	The request contains neither `add_test_cases` nor `remove_test_cases`, or the array it contains is empty.
`only_one_operation_allowed`	The request contains both `add_test_cases` and `remove_test_cases`.
`invalid_preserve_flag`	`preserve_existing_results` is set to a value that is not a boolean.
`invalid_entry_shape`	An entry does not have the expected structure, or its `test_case_ids` is not a non-empty array of strings.
`invalid_test_case_id`	A value in `test_case_ids` does not exist in the project, or resolves to more than one test case.
`invalid_configuration_ids`	A value in `configuration_ids` is not an integer, is repeated, or does not exist in your group.
`invalid_source_project_id`	`source_project_id` is not a positive integer, or the entry sets both `source_project_id` and `source_project`.
`invalid_source_project`	`source_project` is not a project identifier in the form `PR-123`.
`duplicate_test_case_id`	The same test case ID appears more than once in the operation.
`max_test_cases_per_request_exceeded`	The request references more than 300 unique test case IDs.
`validation_failed`	The request fails a validation rule not covered by the other codes.
`configuration_validation_unavailable`	The configuration lookup service is unavailable. Retry the request.

Remove test cases from a test run by identifier

POST /api/v2/projects/{project_id}/test-runs/{test_run_id}/test-cases/remove

Use this API to remove specific test cases from a test run in a single synchronous call. Name the test cases by identifier. Unlike Add or remove test cases in a test run, this API applies the removal before it responds. The execution results of the test cases that remain in the run are not affected.

To call this API, you need the id of the project and the id of the test run. Keep the PR- and TR- prefixes in both IDs.

Send the identifiers in a test_case_identifiers array. The API removes the test cases under every configuration they hold in the run. To remove a test case under specific configurations only, use Add or remove test cases in a test run.

Note:

A request can list up to 100 unique identifiers. The API ignores repeated identifiers.

The removal is atomic. If any identifier is not in the project or not in the run, the API rejects the request. Nothing is removed.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/{project_id}/test-runs/{test_run_id}/test-cases/remove

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Request body

Request Body

{
  "test_case_identifiers": ["TC-104", "TC-105"]
}

test_case_identifiers^* Array

Identifiers of the test cases to remove, such as ["TC-104", "TC-105"]. List between 1 and 100 unique identifiers.

Response attributes `200 OK` `json`

Response

{
  "success": true,
  "data": {
    "removed_count": 2,
    "removed_identifiers": ["TC-104", "TC-105"]
  }
}

success Boolean

Indicates whether the test cases were removed.
data Object

Details of the removal.

▶ SHOW VALUES
- removed_count Integer
  
  Number of test cases removed from the test run.
- removed_identifiers Array
  
  Identifiers of the test cases that were removed.
errors Array

Reasons the request failed. Present only when success is false.

▶ SHOW VALUES
- identifier String
  
  Identifier of the test case that could not be removed. Present when the error applies to one test case.
- message String
  
  Reason the test case could not be removed.

Error responses

When an identifier cannot be removed, the API returns an errors array. Each entry names the identifier that failed and the reason. Nothing is removed. For the HTTP status codes this API can return, refer to Response status codes.

Response

{
  "success": false,
  "errors": [
    {
      "identifier": "TC-999",
      "message": "test case not found in test run"
    }
  ]
}

Close a test run

POST /api/v2/projects/{project_id}/test-runs/{test_run_id}/close

Invoking this API will close test runs in a given project. To close a test run, you will need the id of test run and id of the project in which the test run exists.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/PR-13/test-runs/TR-128/close

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Response attributes `200 OK` `json`

Response

{
  "success": true,
  "testrun": {
    "active_state": "closed",
    "run_state": "closed",
    "created_at": "2023-12-21T09:03:10.000Z",
    "updated_at": "2023-12-28T11:45:22.000Z",
    "description": "Login functionality under user load",
    "identifier": "TR-128",
    "name": "Test Run-05/12/2023",
    "assignee": "john@email.com",
    "project_id": "PR-13",
    "tags": ["test", "regression"],
    "configurations": [101, 102, 103],
    "filter_test_cases": {
      "is_dynamic": false
    },
    "links": {
      "self": "/api/v2/projects/PR-13/test-runs/TR-128",
      "test_cases": "/api/v2/projects/PR-13/test-runs/TR-128/test-cases"
    },
    "urls": {
      "self": "https://test-management.browserstack.com/projects/13/test-runs/TR-128"
    }
  }
}

success Boolean

Indicates whether the API call succeeded.
testrun Object

The closed test run and its attributes.

▶ SHOW VALUES

Delete a test run

POST /api/v2/projects/{project_id}/test-runs/{test_run_id}/delete

Invoking this API will delete a test run. You will need the id of the project and id of the test run to delete a test run.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/PR-1/test-runs/TR-1234/delete

project_id^* String

Identifier of the project.
test_run_id^* String

Identifier of the test run.

Response attributes `200 OK` `json`

Response

{
    "success": true,
    "message": "Test Run TR-1234 has been deleted successfully"
}

success Boolean

API call is executed successfully.
message String

Gives the information about the performed action.

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Test runs

Get test runs list

Request parameters

project_id* String

Response attributes 200 OK json

active_state String

run_state String

assignee String

created_at String

identifier String

name String

project_id String

test_cases_count Integer

configurations Array

Create a test run

Request parameters

project_id* String

Request body

name String

description String

run_state String

assignee String

test_case_assignee String

tags Array

issues Array

issue_tracker Object

name String

host String

configurations Array

configuration_map Array

test_case_id Array or String

configuration_ids Array

test_plan_id String

sub_test_plan_id String

test_cases Array

folder_ids Array

include_all Boolean

filter_scope String

filter_test_cases Object

status Array

priority Array

case_type Array

owner Array

tags Array

custom_fields Object

Response attributes 200 OK json

success Boolean

active_state String

run_state String

created_at String

description String

identifier String

name String

assignee String

project_id String

tags Array

test_cases_count Integer

updated_at String

Clone a test run

Request parameters

project_id* String

test_run_id* String

Request body

test_case_selection String

statuses Array

copy_tc_assignee Boolean

copy_tags Boolean

copy_issues Boolean

name String

Response attributes 200 OK json

success Boolean

test_run Object

identifier String

name String

run_state String

active_state String

description String

assignee String

tags Array

configurations Array

project_id^* String

Response attributes `200 OK` `json`

project_id^* String

Response attributes `200 OK` `json`

project_id^* String

test_run_id^* String

Response attributes `200 OK` `json`

project_id^* String

test_run_id^* String

Response attributes `200 OK` `json`

project_id^* String

test_run_id^* String

Response attributes `200 OK` `json`

project_id^* String

test_run_id^* String

Response attributes `200 OK` `json`