PayloadKit

Proxies

com.apple.SystemConfiguration

The payload that configures network proxies for a device.

macOS 10.7+
Apple schemaexclusive

Not available with User Enrollment · Only one instance per profile · macOS: device channel only

Configuration Keys (1)

KeyTypeTitle
Proxiesrequired

The dictionary containing all the proxies for this device.

dictProxy Configuration
HTTPEnable

If 'true', enables web proxy.

Default: 0

integerEnable HTTP Proxy
HTTPProxy

The host name or IP address for the web proxy.

stringHTTP Proxy Hostname
HTTPPort

The web proxy port.

Default: 80

integerHTTP Proxy Port
HTTPSEnable

If 'true', enables secure web proxy.

Default: 0

integerEnable HTTPS Proxy
HTTPSProxy

The host name or IP address for the secure web proxy.

stringHTTPS Proxy Hostname
HTTPSPort

The secure web proxy port.

Default: 80

integerHTTPS Proxy Port
FTPEnable

If 'true', enables FTP proxy.

Default: 0

integerEnable FTP Proxy
FTPPassive

If 'true', enables passive FTP mode.

Default: 0

integerUse Passive FTP Mode (PASV)
FTPProxy

The host name or IP address for the FTP proxy.

stringFTP Proxy Hostname
FTPPort

The FTP proxy port.

Default: 80

integerFTP Proxy Port
SOCKSEnable

If 'true', enable the SOCKS proxy.

Default: 0

integerEnable SOCKS Proxy
SOCKSProxy

The host name or IP address for the SOCKS proxy.

stringSOCKS Proxy Hostname
SOCKSPortInteger

The port on which to connect to the socks proxy server.

Default: 80

integerSOCKS Proxy Port
RTSPEnable

If 'true', enable streaming proxy.

Default: 0

integerEnable RTSP Steaming Proxy
RTSPProxy

The host name or IP address for the streaming proxy.

stringRTSP Proxy Hostname
RTSPPort

The streaming proxy port.

Default: 80

integerRTSP Proxy Port
GopherEnable

If 'true', enables gopher proxy.

Default: 0

integerEnable Gopher Proxy
GopherProxy

The host name or IP address for the gopher proxy.

stringGopher Proxy Hostname
GopherPort

The gopher proxy port.

Default: 80

integerGopher Proxy Port
ExceptionsList

The list of hosts and domains that should bypass proxy settings.

arrayExceptions
Exceptionrequired

Bypass proxy settings for these Hosts & Domains

stringBypassed Domain
ProxyAutoConfigEnable

If 'true', enables automatic proxy configuration.

Default: 0

integerEnable Automatic Proxy Configuration
ProxyAutoConfigURLString

The automatic proxy configuration URL.

Depends on: Proxies.ProxyAutoConfigEnable ∈ [1]

stringAutomatic Proxy Configuration URL
FallBackAllowed

If '1', enables fallback. Default is '1'. For managed devices, if not supplied, the default is '0'.

integerAllow Proxy PAC Fallback
ProxyCaptiveLoginAllowed

macOS 10.9+

If 1, allows client to log into captive portal network.

Default: 0

integerAllow Proxy Bypass for Captive Portal Logins
SOCKSPortinteger

The SOCKS proxy port.

integerSOCKS Port