Table of Contents
AUTOMATE API

Plan

Plan API helps obtain information about your Automate plan, including the maximum number of parallel sessions allowed, the number of parallel sessions currently running, and the number of parallel sessions queued.

You can invoke this API to manage the triggering of test sessions on BrowserStack. The API returns the number of currently running parallel sessions, and also the maximum allowed parallel sessions in your plan. This information will help you manage triggering of tests in a better way.

Get plan details

GET /automate/plan.json

Request Parameters

Request

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

No parameter required.

Response Attributes 200 OK JSON

Response

{
    "automate_plan": "Automate Mobile",
    "parallel_sessions_running": 20,
    "team_parallel_sessions_max_allowed": 250,
    "parallel_sessions_max_allowed": 250,
    "queued_sessions": 10,
    "queued_sessions_max_allowed": 240
}
  • automate_plan String

    Specifies your Automate plan name.

  • parallel_sessions_running Integer

    Number of parallel sessions currently running.

  • team_parallel_sessions_max_allowed Integer

    Maximum number of parallel sessions allowed in a team.

  • parallel_sessions_max_allowed Integer

    Maximum number of parallel sessions you can run.

  • queued_sessions Integer

    Number of sessions currently queued.

  • queued_sessions_max_allowed Integer

    Maximum number of sessions that can be queued.

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