web_extensions / latest / api / proxy / settings.html /

proxy.settings

A BrowserSetting object that can be used to change the browser's proxy settings.

Note: The ability to change proxy settings requires private window access because proxy settings affect both private and non-private windows. Therefore, if an extension has not been granted private window permission, calls to proxy.settings.set() will throw an exception.

The underlying value is an object with the properties listed below.

When setting this object, all properties are optional. Note that any properties that are omitted will be reset to their default value.

autoConfigUrl Optional

string. A URL to use to configure the proxy.

autoLogin Optional

boolean. Do not prompt for authentication if the password is saved. Defaults to false.

ftp Optional

string. The address of the FTP proxy. Can include a port.

http Optional

string. The address of the HTTP proxy. Can include a port.

httpProxyAll Optional

boolean. Use the HTTP proxy server for all protocols. Defaults to false.

passthrough Optional

string. A comma-separated list of hosts which should not be proxied. Defaults to "localhost, 127.0.0.1".

proxyDNS Optional

boolean. Proxy DNS when using SOCKS5. Defaults to false.

proxyType Optional

string. The type of proxy to use. This may take any one of the following values: "none", "autoDetect", "system", "manual", "autoConfig". Defaults to "system".

socks Optional

string. The address of the SOCKS proxy. Can include a port.

socksVersion Optional

integer. The version of the SOCKS proxy. May be 4 or 5. Defaults to 5.

ssl Optional

string. The address of the SSL proxy. Can include a port.

Examples

let proxySettings = {
  proxyType: "manual",
  http: "http://proxy.org:8080",
  socksVersion: 4,
  passthrough: ".example.org"
};

browser.proxy.settings.set({value: proxySettings});

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
settings
No
No
60
From version 88, the ftp setting has no effect because FTP is no longer supported (see bug 1626365).
?
No
No
?
?
No
?
No
?

© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/proxy/settings

Name Web Extensions
Version
Badge
Last Updated 2022-04-28T06:26:19Z