Configurations

Configurations refer to the combination of operating system, browser, and device. With this API you can get list of configurations and create custom configurations. Configurations help you keep track of the status of Test Cases within a Test Run on different operating systems, browsers, and device combinations.

Get Configurations

GET /api/v2/configurations

Use this API to fetch all the system and custom configurations linked to test cases in a project.

This list is paginated; for more information, refer Pagination.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/configurations

Response Attributes 200 OK json

Response

{
  "success": true,
  "configurations": [
    {
      "id": 5122204,
      "name": "testing_config",
      "os": null,
      "os_version": null,
      "device": null,
      "browser": null,
      "browser_version": null,
      "is_system": false
    },
    {
      "id": 4490607,
      "name": "iOS - iPhone 13 latest",
      "os": "iOS",
      "os_version": "",
      "device": "iPhone 13",
      "browser": "",
      "browser_version": "latest",
      "is_system": false
    }
  ],
  "info": {
        "page": 1,
        "page_size": 30,
        "count": 20,
        "prev": null,
        "next": null
  }

}

Get Configuration by ID

GET /api/v2/configurations/{configuration_id}

Use this API to fetch both the system-defined and user-defined configuration details associated with a specific id. You will need the id of the configuration.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/configurations/{configuration-id}

Response Attributes 200 OK json

Response

{
    "success": true,
    "configuration": {
        "id": 4490607,
        "name": "iOS - iPhone 13 latest",
        "os": "iOS",
        "os_version": "",
        "device": "iPhone 13",
        "browser": "",
        "browser_version": "latest",
        "is_system": false
    }
}

Add Custom Configuration

POST /api/v2/configurations

This API allows you to create and add new custom configuration.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/configurations

Request Body

Request Body

{
  "name": "custom_config"
}

Response Attributes 200 OK json

Response

{
  "success": true,
  "id": 123,
  "name": "custom_config"
}