No Result Found

Project

Projects are organizational structures for builds. Use our REST API to access the project list, fetch project details, update the project name, and delete a project.

Get project list

GET /automate-turboscale/v1/projects

Invoking this API will fetch you the list of projects associated with your username and access key. You will need the id of the project for invoking any other Project API that follows in this document.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api.browserstack.com/automate-turboscale/v1/projects

No parameter is required.

Response Attributes 200 OK Array

Response

{
    "projects": [
        {
        "id": 866256,
        "name": "pricing_project",
        "group_id": 2,
        "user_id": 256454,
        "created_at": "2020-02-13T12:18:08.000Z",
        "updated_at": "2020-09-03T07:13:15.000Z",
        "sub_group_id": 3
        },
        {
        "id": 874983,
        "name": "navigation_project",
        "group_id": 2,
        "user_id": 1344744,
        "created_at": "2020-03-11T10:14:36.000Z",
        "updated_at": "2020-09-18T09:45:57.000Z",
        "sub_group_id": 0
        },
        {...}
    ]
}

  • id Integer

    ID of your project.

  • name String

    Name of your project.

  • group_id Integer

    Identifier for your account or group.

  • user_id Integer

    Identifier for the user.

  • created_at String

    Time at which the project was created on BrowserStack servers.

  • updated_at String

    Time at which the project was updated on BrowserStack servers.

  • sub_group_id Integer

    Identifier for a team in a group.

Get project details

GET /automate-turboscale/v1/projects/{project_id}

Once the list of projects is available, more specific information about a particular project can be queried using the project ID by invoking this API.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api.browserstack.com/automate-turboscale/v1/projects/<project-id>

  • id* number

    ID of the project.

Response Attributes 200 OK JSON

Response

{
    "id": 966019,
    "name": "pricing_project",
    "group_id": 2,
    "user_id": 3852199,
    "created_at": "2020-09-01T15:06:30.000Z",
    "updated_at": "2020-09-01T15:09:37.000Z",
    "sub_group_id": 0,
    "builds": [
        {
            "name": "pricing_project_build",
            "duration": 12,
            "status": "done",
            "build_tags": ["regression", "daily"],
            "group_id": 2,
            "user_id": 3852199,
            "created_at": "2020-09-01T15:09:37.000Z",
            "updated_at": "2020-09-01T15:09:49.000Z",
            "hashed_id": "4207442b2b0567368956dba064c22a3235a76214",
            "sub_group_id": 0,
            "framework": "selenium"
        }
        {...}
    ]
}

  • id Integer

    ID of your project.

  • name String

    Name of your project.

  • group_id Integer

    Identifier for your account or group.

  • user_id Integer

    Identifier for the user.

  • created_at String

    Time at which the project was created on BrowserStack servers.

  • updated_at String

    Time at which the project was updated on BrowserStack servers.

  • sub_group_id Integer

    Identifier for a team in a group.

  • builds Array

    Details of the build.

    ▶ SHOW VALUES

    • name String

      Name of the build.

    • duration Integer

      Duration of build execution.

    • status String

      Status of the build.

    • group_id Integer

      An identifier for your account or group.

    • user_id Integer

      An identifier for the user.

    • created_at String

      Time at which the build was created on BrowserStack servers.

    • updated_at String

      Time at which the build was updated on BrowserStack servers.

    • hashed_id String

      Unique Hashed ID of the build.

    • sub_group_id Integer

      An identifier for a team in a group.

    • build_tags Array

      A list of Build Tags attached to a build.

    • framework String

      Test Framework used for running the build.

Update project details

PATCH /automate-turboscale/v1/projects/{project_id}

You can update the name of your project after the project is complete using the PATCH method.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X PATCH -H "Content-Type: application/json" \
-d "{\"name\":\"<project-name>\"}" \
https://api.browserstack.com/automate-turboscale/v1/projects/<project-id>

  • id* String

    ID of the project.

  • name* String

    Updated name of the project.

Response Attributes 200 OK JSON

Response

{
    "id":966019,
    "name":"pricing_project",
    "group_id":2,
    "user_id":3852199,
    "created_at":"2020-09-01T15:06:30.000Z",
    "updated_at":"2020-09-02T12:20:03.442Z",
    "sub_group_id":0
}

  • id Integer

    ID of your project.

  • name String

    Updated name of your project.

  • group_id Integer

    Identifier for your account or group.

  • user_id Integer

    Identifier for the user.

  • created_at String

    Time at which the project was created on BrowserStack servers.

  • updated_at String

    Time at which the project was updated on BrowserStack servers.

  • sub_group_id Integer

    Identifier for a team in a group.

Delete project

DELETE /automate-turboscale/v1/projects/{project_id}

You can delete a project on the server using the DELETE method. Please note that to delete a project, it needs to be empty of builds and sessions, and projects once deleted cannot be recovered.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X DELETE https://api.browserstack.com/automate-turboscale/v1/projects/<project-id>

  • id* String

    ID of the project.

Response Attributes 200 OK JSON

Response

{
    "status":"ok",
    "message":"Project 966019 was deleted successfully."
}

  • status String

    Status of deletion.

  • message String

    Project deletion message.

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





Thank you for your valuable feedback

Download Copy Check Circle