Skip to content

Commit 6509c6d

Browse files
minoli-vfrancisf
authored andcommitted
Added an API request that returns worker details
I've added an API request that returns details of all browser workers created by users.
1 parent e3d7879 commit 6509c6d

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,33 @@ For example:
315315
curl -u "username:access_key" https://api.browserstack.com/5/worker/123456789/screenshot.json
316316
```
317317

318+
## Get Details of all Browser Workers
319+
This API request returns comprehensive information of all browser workers you’ve created.
320+
321+
```http
322+
GET /workers
323+
```
324+
Example request:
325+
```bash
326+
curl -u "username:access_key" -X GET https://api.browserstack.com/5/workers
327+
```
328+
329+
Example response:
330+
```javascript
331+
[{
332+
"id": "<workerId>",
333+
"status": "running",
334+
"os": "OS X",
335+
"os_version": "Mojave",
336+
"browser": "chrome",
337+
"browser_version": "75.0",
338+
"real_mobile": null,
339+
"device": null,
340+
"browser_url": "<dashboard_url_of_the_session>",
341+
"sessionId": "<sessionId>"
342+
}]
343+
```
344+
318345
## Terminating a Browser Worker
319346

320347
Use this method to terminate a worker. Useful if you set the worker up to run indefinitely or if you've received all the information needed and you want to save on credit time.

0 commit comments

Comments
 (0)