Start

POST/start

Last modified: 2 months ago

Start a browser

Request

Authorization: API Key

Add parameter in header

x-api-key

Example

x-api-key: 2f68dbbf-519d-4f01-9636-e2421b68f379

autoClose

boolean

optional

indicates autoclose browser after finished

headless

string

optional

name

string

optional

profile name

Example:

Profile

platform

enum<string>

optional

fingerprint os platform

Allowed values:

windowsmaclinux

Example:

windows

proxy

string

optional

profile proxy

Example:

http://username:password@ip:port

proxies

array[string]

optional

if proxy is empty, randomly select one from proxies

doProxyChecking

boolean

optional

indicates do proxy checking when launch a profile, fingerprints based on ip working when true, it will take more time to launch. available in 130-202411051500.v2 and newer docker image.

remoteDebuggingPort

integer

optional

browser port

startupUrls

array[string]

optional

startup urls

args

object

optional

custom args with kernel command line switches,for example: {"--proxy-bypass-list":"domain1,domain2", "--headless":""}

Additional properties

string

optional

fingerprint

object

optional

custom fingerprint

deviceMemory

enum<integer>

optional

deviceMemory

Allowed values:

248

Example:

disableImageLoading

boolean

optional

disableImageLoading

doNotTrack

boolean

optional

DoNotTrack

flags

object

optional

fingerprint flags

fonts

array[string]

optional

fonts list,works on flags.fonts == 'Custom'

geolocation

object

optional

geolocation,works on flags.localization == 'Custom'

hardwareConcurrency

enum<integer>

optional

hardwareConcurrency

Allowed values:

24810121416

Example:

localization

object

optional

languages,works on flags.localization == 'Custom'; localization.timezone works on flags.localization == 'Custom'

restoreLastSession

boolean

optional

indicates the last session should be restored on startup

screen

object

optional

screen,works on flags.screen == 'Custom'

userAgent

string

optional

navigator.userAgent

webrtc

object

optional

webrtc ips,works on flags.webrtc == 'Custom'

{
  "name": "testProfile",
  "once": true,
  "platform": "Windows",
  "kernel": "Chrome",
  "kernelMilestone": "130",
  "proxy": "http://127.0.0.1:8000",
  "doProxyChecking": false,
  "fingerprint": {
    "flags": {
      "timezone": "BasedOnIp",
      "screen": "Custom"
    },
    "screen": {
      "width": 1000,
      "height": 1000
    },
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.6723.60 Safari/537.36"
  },
  "args": {
    "--proxy-bypass-list": "domain1,domain2",
    "--load-extension": "extDir1,extDir2"
  }
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

code

integer

optional

data

object (nstbrowser_io_nstbrowserless_server_bo.RuntimeData)

optional

kernel

integer

optional

Example:

kernelMilestone

string

optional

Example:

name

string

optional

Example:

Test

platform

integer

optional

Example:

profileId

string

optional

Example:

12311

remoteDebuggingPort

integer

optional

Example:

9222

running

boolean

optional

Example:

true

starting

boolean

optional

Example:

false

stopping

boolean

optional

Example:

false

err

boolean

optional

msg

string

optional

{
  "code": 0,
  "data": {
    "kernel": 0,
    "kernelMilestone": "91",
    "name": "Test",
    "platform": 0,
    "profileId": "12311",
    "remoteDebuggingPort": 9222,
    "running": true,
    "starting": false,
    "stopping": false
  },
  "err": true,
  "msg": "string"
}

Last modified: 2 months ago