/config API

The /config API returns your worker's current configuration. Available on Private Deployment and Enterprise Docker plans only.

Get Worker Configuration

Issue a GET request to /config:

cURL

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

Javascript

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

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

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

fetchConfig();

Python

import requests

TOKEN = "YOUR_API_TOKEN_HERE"
url = f"https://production-sfo.browserless.io/config?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 FetchConfig {
    public static void main(String[] args) {
        String TOKEN = "YOUR_API_TOKEN_HERE";
        String url = "https://production-sfo.browserless.io/config?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/config?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}");
        }
    }
}

The response returns a JSON object like:

{
  "allowCORS": true,
  "allowFileProtocol": false,
  "allowGetCalls": false,
  "concurrent": 10,
  "data": "/tmp/browserless-data-dirs",
  "debug": "browserless*,-**:verbose",
  "errorAlertURL": null,
  "healthFailureURL": null,
  "host": "localhost",
  "maxCPU": 99,
  "maxMemory": 99,
  "metricsJSONPath": "/tmp/browserless-metrics.json",
  "port": 3001,
  "queued": 10,
  "queuedAlertURL": null,
  "rejectAlertURL": null,
  "retries": 5,
  "timeout": 30000,
  "timeoutAlertURL": null,
  "token": "6R0W53R135510"
}