Create a proxy

POST/proxies

Create a new proxy configuration in the resolved project.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Configuration for routing traffic through a proxy.

name?string

Readable name of the proxy.

type*string

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

Value in

"datacenter"
"isp"
"residential"
"mobile"
"custom"

protocol?string

Protocol to use for the proxy connection.

Default"https"

Value in

"http"
"https"

bypass_hosts?array<string>

Hostnames that should bypass the parent proxy and connect directly.

config?||||

Configuration specific to the selected proxy type.

Response

application/json

Proxy created successfully

Configuration for routing traffic through a proxy.

id?string

name?string

Readable name of the proxy.

type*string

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

Value in

"datacenter"
"isp"
"residential"
"mobile"
"custom"

protocol?string

Protocol to use for the proxy connection.

Default"https"

Value in

"http"
"https"

bypass_hosts?array<string>

Hostnames that should bypass the parent proxy and connect directly.

status?string

Current health status of the proxy.

Value in

"available"
"unavailable"

last_checked?string

Timestamp of the last health check performed on this proxy.

Formatdate-time

ip_address?string

IP address that the proxy uses when making requests.

config?||||

Configuration specific to the selected proxy type.

curl -X POST "https://example.com/proxies" \  -H "Content-Type: application/json" \  -d '{    "type": "datacenter"  }'

{  "id": "string",  "name": "string",  "type": "datacenter",  "protocol": "http",  "bypass_hosts": [    "string"  ],  "status": "available",  "last_checked": "2019-08-24T14:15:22Z",  "ip_address": "string",  "config": {    "country": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}