List browsers for an invocation

Returns all active browser sessions created within the specified invocation.

GET /invocations/{id}/browsers

JavaScript

JavaScript

import Kernel from '@onkernel/sdk';

const client = new Kernel({
  apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});

const response = await client.invocations.listBrowsers('id');

console.log(response.browsers);

import os
from kernel import Kernel

client = Kernel(
    api_key=os.environ.get("KERNEL_API_KEY"),  # This is the default and can be omitted
)
response = client.invocations.list_browsers(
    "id",
)
print(response.browsers)

package main

import (
	"context"
	"fmt"

	"github.com/kernel/kernel-go-sdk"
	"github.com/kernel/kernel-go-sdk/option"
)

func main() {
	client := kernel.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Invocations.ListBrowsers(context.TODO(), "id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Browsers)
}

curl --request GET \
  --url https://api.onkernel.com/invocations/{id}/browsers \
  --header 'Authorization: Bearer <token>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/invocations/{id}/browsers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.onkernel.com/invocations/{id}/browsers")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/invocations/{id}/browsers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "browsers": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "cdp_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/cdp?jwt=eyJ0eXAi...",
      "webdriver_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi...",
      "headless": false,
      "stealth": false,
      "session_id": "htzv5orfit78e1m2biiifpbv",
      "timeout_seconds": 123,
      "browser_live_view_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJ0eXAi...",
      "base_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/kernel",
      "gpu": false,
      "profile": {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "last_used_at": "2023-11-07T05:31:56Z"
      },
      "proxy_id": "<string>",
      "pool": {
        "id": "<string>",
        "name": "<string>"
      },
      "viewport": {
        "width": 1280,
        "height": 800,
        "refresh_rate": 60
      },
      "kiosk_mode": false,
      "start_url": "https://example.com",
      "chrome_policy": {},
      "deleted_at": "2023-11-07T05:31:56Z",
      "usage": {
        "uptime_ms": 123
      },
      "telemetry": {
        "browser": {
          "console": {
            "enabled": true
          },
          "page": {
            "enabled": true
          },
          "interaction": {
            "enabled": true
          },
          "network": {
            "enabled": true
          }
        }
      }
    }
  ]
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Invocation ID

Response

200

application/json

List of browsers for this invocation

browsers · object[] · required

Show child attributes