Skip to main content
POST
Create a proxy

Authorizations

Authorization
string
header
required

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

Body

application/json

Configuration for routing traffic through a proxy.

host
string
required

Proxy host address or IP.

Example:

"127.0.0.1"

port
integer
required

Proxy port.

Example:

8080

type
enum<string>
required

Proxy type to use. In terms of quality for avoiding bot-detection, from best to worst: mobile > residential > isp > datacenter.

Available options:
datacenter,
isp,
residential,
mobile,
custom
has_ca_bundle
boolean

Whether the proxy has a custom CA bundle configured.

Example:

true

has_password
boolean

Whether the proxy has a password.

Example:

true

username
string

Username for proxy authentication.

Example:

"user123"

bypass_hosts
string[]

Hostnames that should bypass the parent proxy and connect directly.

config
Datacenter · object

Configuration specific to the selected proxy type.

name
string

Readable name of the proxy.

protocol
enum<string>
default:https

Protocol to use for the proxy connection.

Available options:
http,
https

Response

Proxy created successfully

Configuration for routing traffic through a proxy.

host
string
required

Proxy host address or IP.

Example:

"127.0.0.1"

port
integer
required

Proxy port.

Example:

8080

type
enum<string>
required

Proxy type to use. In terms of quality for avoiding bot-detection, from best to worst: mobile > residential > isp > datacenter.

Available options:
datacenter,
isp,
residential,
mobile,
custom
has_ca_bundle
boolean

Whether the proxy has a custom CA bundle configured.

Example:

true

has_password
boolean

Whether the proxy has a password.

Example:

true

username
string

Username for proxy authentication.

Example:

"user123"

bypass_hosts
string[]

Hostnames that should bypass the parent proxy and connect directly.

config
Datacenter · object

Configuration specific to the selected proxy type.

id
string
ip_address
string

IP address that the proxy uses when making requests.

Example:

"192.168.1.1"

last_checked
string<date-time>

Timestamp of the last health check performed on this proxy.

name
string

Readable name of the proxy.

protocol
enum<string>
default:https

Protocol to use for the proxy connection.

Available options:
http,
https
status
enum<string>

Current health status of the proxy.

Available options:
available,
unavailable