Skip to main content
PATCH

Price

Free. See Pricing.

Authorizations

Authorization
string
header
required

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

Path Parameters

session_id
string
required

Body

application/json
mode
enum<string>

managed is the default network, direct uses none, custom takes customProxy.

Available options:
managed,
direct,
custom
country
string

managed: the country to appear in, such as DE.

rotate
boolean

true gets a new address in the current country.

customProxy
object

Your own proxy, with mode custom.

Response

How the session reaches the web now.

success
any
required
creditsUsed
integer
required
costUsd
number
required

What this call cost, in dollars.

requestId
string
required
mode
enum<string>

managed is the default network, direct has no proxy, custom is your own.

Available options:
managed,
direct,
custom
country
string | null

The country a managed session appears in.

exitIp
string | null

The address sites see. Null for your own proxy, and null with exitIpError when the address could not be read.

exitIpError
string

Present when exitIp is null because the address could not be read. Send the request again.