ConnectBrowser - Nstbrowser API

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

profileId

string

required

profileId

Query Params

config

string

optional

profile options in URL-encoded format json string, see full schema in Body Params, please note that you can't carrying a Request Body in aWS/GETrequest so you have to encode params in URL-encoded format

Example:

%7B%0A++++%22headless%22%3A+true%0A%7D

Body Params application/json

autoClose

boolean

optional

indicates autoclose browser after finished

timedCloseSec

integer

optional

indicates autoclose browser after specified seconds

Example:

30

clearCacheOnClose

boolean

optional

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

headless

string

optional

incognito

boolean

optional

incognito mode

proxy

string

optional

profile proxy, higher priority than proxyGroupName

Example:

http://username:password@ip:port

skipProxyChecking

boolean

optional

indicates skip proxy checking when launch profile

remoteDebuggingPort

integer

optional

browser port

startupUrls

array[string]

optional

startup urls

urlBlockList

array[string]

optional

url block list, for example: www.example.com, you also can add file://* to block all file protocol urls

urlAllowList

array[string]

optional

url allow list in url block list, for example, you can add file://foo to unblock from url block list

args

object

optional

custom args with kernel command line switches

Additional properties

string

optional

Example

{}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request WS 'http://localhost:8848/api/v2/connect/?config=%7B%0A++++%22headless%22%3A+true%0A%7D' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{}'

Responses

🟢200OK

application/json

OK

Body

code

integer

optional

data

object (browser.RemoteDebuggingAddress)

optional

port

integer

optional

profileId

string

optional

proxy

string

optional

webSocketDebuggerUrl

string

optional

err

boolean

optional

msg

string

optional

Example

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