/sessions API

The /sessions API returns a list of currently running browser sessions. Available on Private Deployment and Enterprise Docker plans only.

To create and manage persistent browser sessions, see the Session Management documentation.

Prerequisites

• A Browserless Enterprise license (self-hosted Docker or Private Deployment)

Listing Running Sessions

Issue a GET request to /sessions to list running sessions:

cURL

curl -X GET \
  https://production-sfo.browserless.io/sessions?token=YOUR_API_TOKEN_HERE

Javascript

const TOKEN = "YOUR_API_TOKEN_HERE";
const url = `https://production-sfo.browserless.io/sessions?token=${TOKEN}`;

const fetchSessions = async () => {
  const response = await fetch(url, {
    method: 'GET'
  });

  const result = await response.json();
  console.log(result);
};

fetchSessions();

Python

import requests

TOKEN = "YOUR_API_TOKEN_HERE"
url = f"https://production-sfo.browserless.io/sessions?token={TOKEN}"

response = requests.get(url)
result = response.json()

print(result)

Java

import java.io.*;
import java.net.URI;
import java.net.http.*;

public class FetchSessions {
    public static void main(String[] args) {
        String TOKEN = "YOUR_API_TOKEN_HERE";
        String url = "https://production-sfo.browserless.io/sessions?token=" + TOKEN;

        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .GET()
            .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println("Response: " + response.body());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

C#

using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program {
    static async Task Main(string[] args) {
        string TOKEN = "YOUR_API_TOKEN_HERE";
        string url = $"https://production-sfo.browserless.io/sessions?token={TOKEN}";

        using var client = new HttpClient();

        try {
            var response = await client.GetAsync(url);
            response.EnsureSuccessStatusCode();

            var result = await response.Content.ReadAsStringAsync();
            Console.WriteLine("Response: " + result);
        } catch (Exception ex) {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

warning

Running this in the browser exposes your API token.

Running this request will result in an output like:

[{
  "id": null,
  "initialConnectURL": "wss://production-sfo.browserless.io/firefox/playwright/?token=YOUR_API_TOKEN_HERE",
  "isTempDataDir": true,
  "launchOptions": {},
  "numbConnected": 1,
  "routePath": ["/firefox/playwright", "/firefox/playwright"],
  "startedOn": 1709584439748,
  "ttl": 0,
  "userDataDir": null,
  "browser": "FirefoxPlaywright",
  "browserId": "d9a8570a73666d79d79ac23f07cf8966",
  "killURL": null,
  "running": true,
  "timeAliveMs": 10118,
  "type": "browser"
}]

FAQ & Troubleshooting

How do I get an Enterprise license?

Contact sales@browserless.io or visit the pricing page for Enterprise plan details.

Can I run Browserless on my own infrastructure?

Yes. Enterprise customers can self-host using the Docker image. See Docker deployment for setup instructions.

Next steps

Docker deployment

self-host Browserless with Docker

Launch parameters

configure your Enterprise deployment