PhantomJsCloud.com API Documentation
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IProxyCustomOptions

Index

Properties

Properties

Optional auth

auth: string

if your proxy requires basic HTTP authentication information.

this auth pair will be sent via basic http auth (overriding IRequestSettings.authentication)

IMPORTANT: authentication is only supported for http and https proxies. If you are using a socks5 proxy, auth is not currently supported.

example

auth:"username:password"

Optional authHeaders

authHeaders: {}

new for Chrome backend. (not available on WebKit).

the headers that should be supplied for proxy authentication. they will be sent with every resource request

example

authHeaders:{"Proxy-Authorization":"Basic yoursecretkey"}

Type declaration

  • [name: string]: string

host

host: string

For Chrome backend, pass the full URL: such as http://proxy.example.com:8088.

For old WebKit backend: the address and port of the proxy server to use. ex: 192.168.1.42:8080 If your proxy requires a IP to whitelist, use api-static.phantomjscloud.com for your requests.

Optional type

type: string
deprecated:

old WebKit backend only. If using the Chrome backend, pass the type as part of the host parameter. for type of the proxy server. default is http available types are http, socks5, and none