Skip to main content
No Result Found
Connect & Get help from fellow developers on our Discord community. Ask the CommunityAsk the Community

Plan

Use our REST API to fetch details about your group’s App Automate plan, including the maximum number of parallel tests allowed, the number of parallel tests currently running, and the number of parallel tests queued. You can use this information to manage the execution of parallel tests while running your builds.

Get plan details

GET /app-automate/plan.json

Get BrowserStack plan details in real-time.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/plan.json"

No parameter required.

Response Attributes 200 OK application/json

Response

{
  "automate_plan": "App Automate",
  "terminal_access": "Public",
  "parallel_sessions_running": 0,
  "team_parallel_sessions_max_allowed": 25,
  "parallel_sessions_max_allowed": 25,
  "queued_sessions": 0,
  "queued_sessions_max_allowed": 25
}
  • automate_plan String

    Your BrowserStack App Automate plan.

  • terminal_access String

    Specifies if devices are allotted exclusively to the group. For smart tv users, variable value is Private.

  • parallel_sessions_running Integer

    Number of parallel tests currently running.

  • parallel_sessions_max_allowed Integer

    Maximum number of parallel tests available in your BrowserStack App Automate plan.

  • team_parallel_sessions_max_allowed Integer

    Number of parallel tests allocated to your team.

  • queued_sessions Integer

    Number of tests currently queued.

  • queued_sessions_max_allowed Integer

    Maximum number of tests allowed to be queued.

Monitor parallel and queue usage details

GET /app-automate/current_parallel_queue_usage

Monitor BrowserStack parallel and queue usage details in real-time.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \ 
"https://api-cloud.browserstack.com/app-automate/current_parallel_queue_usage"

No parameter required.

Response Attributes 200 OK application/json

Response

{
  "meta": {
    "generatedAt": "2025-09-19T06:10:40Z",
    "persona": "org access",
    "summary": {
      "totalParallelsUsed": 5,
      "maximumParallelsAllowed": 25,
      "totalQueuedSessions": 5,
      "maximumQueueAllowed": 25
    }
  },
  "usageByTeam": [
    {
      "teamId": null,
      "teamName": null,
      "maximumTeamParallelsAllowed": null,
      "members": [
        {
          "userId": 400000,
          "userName": "John Doe",
          "parallelsUsed": 4,
          "sessionQueued": 0
        }
      ]
    }
  ]
}
  • totalParallelsUsed String

    Total number of parallels currently in use.

  • maximumParallelsAllowed String

    Maximum number of parallels allowed for the user or team.

  • totalQueuedSessions Integer

    Current number of queued sessions for the user’s group.

  • maximumQueueAllowed Integer

    Maximum allowed queue length for the user’s group.

  • usageByTeam Array

    An array of objects, each detailing usage by a specific team.

  • teamId Integer

    The unique identifier for the team. This can be null if the user is not part of a team.

  • teamName String

    The name of the team. This can be null if the user is not part of a team.

  • maximumTeamParallelsAllowed Integer

    The maximum number of parallel sessions allowed for this specific team.

  • members Array

    An array of objects, each containing usage details for a team member.

  • userId Integer

    The unique identifier for the user.

  • userName String

    The full name of the user.

  • parallelsUsed Integer

    The number of parallels currently being used by this specific user.

  • sessionQueued Integer

    The number of sessions currently queued by this specific user.

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