From 4da7374a3ab61fa9db4969d10f4413e8ee794e07 Mon Sep 17 00:00:00 2001 From: Rahul Nawani Date: Wed, 30 Jan 2013 10:17:27 +0530 Subject: [PATCH 1/2] update api docs --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 962510f..e1a2c3a 100644 --- a/README.md +++ b/README.md @@ -172,3 +172,31 @@ This method will return the list of workers whose status is either `queue` or `r } ... ] ``` + + +## Getting API Status +If you want to know the status of your API, use the following method + + GET /status + +This will return the current status of API, like how much API time has been used and how many workers are runnning parallely. + +```javascript + { + used_time: '4235.4', + total_available_time: '6000', + running_windows_sessions: '1', + windows_sessions_limit: '1' + running_mac_sessions: '1', + mac_sessions_limit: '2' + } +``` +The time returned is in seconds. + +If a user runs out of API time, all requests will return following response + +```javascript + { + message: "You have run out of API time" + } +``` From 8f5c79fee63a1ba97d862456bdf6061885720d29 Mon Sep 17 00:00:00 2001 From: Irfan Wadia Date: Wed, 20 Apr 2016 13:36:47 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e1a2c3a..17e61b4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +**Note:** This version of the BrowserStack API has been deprecated. Please use [BrowserStack API v4.0](https://github.com/browserstack/api) # API Overview The following denotes the HTTP-based API for [BrowserStack](http://www.browserstack.com). It provides browser-as-a-service for automated cross-browser testing. The goal is to provide a simple service which can easily be used by any browser testing framework.