Contains information about a proxy. This object, or an array of these objects, is returned from the listener to
proxy.onRequest. It instructs the browser whether to proxy the request, and if so, which proxy to use.
Values of this type are objects. They contain the following properties:
string. This describes whether to proxy at all, and if so, what kind of proxy to use. It may take one of the following values:
"direct": don't proxy the request. If this value is given, all other properties of this object are ignored.
"http": HTTP proxy (or SSL CONNECT for HTTPS)
"https": HTTP proxying over TLS connection to proxy
"socks": SOCKS v5 proxy
"socks4": SOCKS v4 proxy
string. The hostname of the proxy server. Mandatory unless
string. The port number of the proxy server. Mandatory unless
string. Username for the proxy service. This is usable with "socks". For HTTP proxy authorizations, use
string. Password for the proxy service. This is usable with "socks". For HTTP proxy authorizations, use
boolean. If true, the proxy server is used to resolve certain DNS queries (only usable with
"socks"). Defaults to
number. Failover timeout in seconds. If the connection fails to connect the proxy server after this number of seconds, the next proxy server in the array returned from the
proxy.onRequestlistener will be used.
string.This string, if set to non-empty, is passed directly as a value to the
Proxy-Authorizationrequest header sent to HTTP proxies as part of plain HTTP requests and CONNECT requests. In other words, this can be used to directly authenticate to HTTP proxies requiring (non-challenging) authentication.
For instance, if you want to send "username" and "password" for "basic" authentication, you can set the
string.An optional key used for additional isolation of this proxy connection.
BCD tables only load in the browser
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.