🎉The new Browserless is Live! Experience the future of web scraping now!🎉

Nstbrowser API

BatchUpdateProxy

PUT

/profiles/proxy/batch

v2/Profiles/Proxy

batch update proxy for profiles, url cannot be empty at the same time as protocol, host, and port

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Body Params application/json

profileIds

array[string]

optional

profile ids

proxyConfig

object

optional

profile's proxy config

url

string

optional

proxy url, format: {scheme}://{username}:{password}@{host}:{port}

protocol

string

optional

proxy scheme

username

string

optional

proxy username

password

string

optional

proxy password

host

string

optional

proxy host

port

string

optional

proxy port

Example

{
  "profileIds": [
    "86b68026-0d68-4ce0-a30f-ccf58632446c"
  ],
  "proxyConfig": {
    "url": "http://admin:[email protected]:8000"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'http://localhost:8848/api/v2/profiles/proxy/batch' \
--header 'Content-Type: application/json' \
--data-raw '{
    "profileIds": [
        "86b68026-0d68-4ce0-a30f-ccf58632446c"
    ],
    "proxyConfig": {
        "url": "http://admin:[email protected]:8000"
    }
}'

Responses

🟢200OK

application/json

Body

code

integer

optional

data

string

optional

err

boolean

optional

msg

string

optional

Example

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

UpdateProfileProxy

ResetProfileProxy