LaunchNewBrowser

GET/devtool/launch

Last modified: 4 months ago

LaunchNewBrowser

Request

Authorization: API Key

Add parameter in header

x-api-key

Example

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

Query Params

config

string

required

launch config, url-encoded json string in query, see full schema in body params

Example:

%7B%0A++++%22name%22%3A+%22testProfile%22%2C%0A++++%22once%22%3A+true%2C%0A++++%22platform%22%3A+%22windows%22%2C%0A++++%22kernel%22%3A+%22chromium%22%2C%0A++++%22kernelMilestone%22%3A+%22128%22%0A%7D

args

object

optional

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

Additional properties

string

optional

autoClose

boolean

optional

indicates autoclose browser after finished

clearCacheOnClose

boolean

optional

indicates delete local userdata when browser closed if not a once profile

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'

forceUseLatestKernel

boolean

optional

force start with latest kernel if no compatible kernel found

Example:

true

groupId

string

optional

profile group id, invalid for once profile

Example:

1e455935-3e3e-4e3e-8e3e-3e3e3e3e3e3e

groupName

string

optional

an existing group name,prioritize using groupId if set, invalid for once profile

Example:

Default

headless

string

optional

incognito

boolean

optional

incognito mode

kernel

enum<string>

required

kernel type

Allowed value:

chromium

Example:

chromium

kernelMilestone

enum<string>

required

kernelMilestone

Allowed values:

124120113

Example:

124

name

string

required

profile name

Example:

Profile

note

string

optional

profile note, invalid for once profile

once

boolean

optional

once profile, true: auto delete userdata when browser closed; false: create a new profile

Example:

true

platform

enum<string>

required

fingerprint os platform

Allowed values:

windowsmaclinux

Example:

windows

proxy

string

optional

profile proxy, higher priority than proxyGroupName

Example:

http://username:password@ip:port

proxyGroupName

string

optional

an existing proxy group name, invalid for once profile

cookieProfileIds

string

optional

[!experimental]
inheriting cookies from profileIds, currently accepts only one profileId

remoteDebuggingPort

integer

optional

browser port

startupUrls

array[string]

optional

startup urls

timedCloseSec

integer

optional

indicates autoclose browser after specified seconds

Example:

{
  "name": "testProfile",
  "once": true,
  "platform": "windows",
  "kernel": "chromium",
  "kernelMilestone": "128",
  "proxy": "http://127.0.0.1:8000",
  "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/128.0.6613.85 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 (browser.RemoteDebuggingAddress)

optional

port

integer

optional

profileId

string

optional

webSocketDebuggerUrl

string

optional

err

boolean

optional

msg

string

optional

{
  "code": 0,
  "data": {
    "port": 0,
    "profileId": "string",
    "webSocketDebuggerUrl": "string"
  },
  "err": true,
  "msg": "string"
}

Last modified: 4 months ago