Skip to main content
No Result Found

Grid

Use our REST API to access different Grid(s), fetch details about the Grid.

Get Grid list

GET /automate-turboscale/v1/grids

Invoking this API will fetch you the list of Grids associated with your account. You will need the id of the grid for invoking any other Grid API that follows in this document.

Request Parameters

Request

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

No parameter is required.

Response Attributes 200 OK Array

Response

{
    "grids": [
        {"id": "8a2f0b57-9d34-4ceb-9789-14539d709e33",
        "name": "turboscale-grid",
        "version": "0.2.3",
        "max_concurrency": 100,
        "running": 10,
        "queued": 0,
        "created_by": "Test Automation",
        "user_id": 123,
        "cloud_details":
            {"provider": "aws", "region": "us-east-1"}}
    ,{...}
    ]
}
  • id Integer

    ID of your grid.

  • name String

    Name of your grid.

  • user_id Integer

    Identifier for the user.

  • version String

    Version of your grid.

  • max_concurrency Integer

    Max Concurrency set for Grid.

  • running Integer

    Count of sessions running on the Grid.

  • queued Integer

    Count of sessions Queued on the Grid.

  • created_by String

    User name for Grid creator.

  • cloud_details Object

    Cloud related information for Grid.

Get grid details

GET /automate-turboscale/v1/grids/{grid_id}

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

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api.browserstack.com/automate-turboscale/v1/grids/<grid-id>
  • id* number

    ID of the Grid.

Response Attributes 200 OK JSON

Response

{
    "id": "8a2f0b57-9d34-4ceb-9789-14539d709e33",
    "name": "turboscale-grid",
    "version": "0.2.3",
    "max_concurrency": 100,
    "running": 10,
    "queued": 0,
    "created_by": "Test Automation",
    "user_id": 123,
    "cloud_details":
        {"provider": "aws", "region": "us-east-1"}
}
  • id Integer

    ID of your grid.

  • name String

    Name of your grid.

  • user_id Integer

    Identifier for the user.

  • version String

    Version of your grid.

  • max_concurrency Integer

    Max Concurrency set for Grid.

  • running Integer

    Count of sessions running on the Grid.

  • queued Integer

    Count of sessions Queued on the Grid.

  • created_by String

    User name for Grid creator.

  • cloud_details Object

    Cloud related information for Grid.

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