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)

KeyTypeDescriptionDefaultRange

Proxy Configuration

required
dictThe dictionary containing all the proxies for this device.Default: —Range: —
HTTPEnableinteger

Enable HTTP Proxy

integerIf 'true', enables web proxy.Default: 0Range: —
HTTPProxystring

HTTP Proxy Hostname

stringThe host name or IP address for the web proxy.Default: —Range: —
HTTPPortinteger

HTTP Proxy Port

integerThe web proxy port.Default: 80Range: —

Enable HTTPS Proxy

integerIf 'true', enables secure web proxy.Default: 0Range: —

HTTPS Proxy Hostname

stringThe host name or IP address for the secure web proxy.Default: —Range: —
HTTPSPortinteger

HTTPS Proxy Port

integerThe secure web proxy port.Default: 80Range: —
FTPEnableinteger

Enable FTP Proxy

integerIf 'true', enables FTP proxy.Default: 0Range: —
FTPPassiveinteger

Use Passive FTP Mode (PASV)

integerIf 'true', enables passive FTP mode.Default: 0Range: —
FTPProxystring

FTP Proxy Hostname

stringThe host name or IP address for the FTP proxy.Default: —Range: —
FTPPortinteger

FTP Proxy Port

integerThe FTP proxy port.Default: 80Range: —

Enable SOCKS Proxy

integerIf 'true', enable the SOCKS proxy.Default: 0Range: —

SOCKS Proxy Hostname

stringThe host name or IP address for the SOCKS proxy.Default: —Range: —

SOCKS Proxy Port

integerThe port on which to connect to the socks proxy server.Default: 80Range: —
RTSPEnableinteger

Enable RTSP Steaming Proxy

integerIf 'true', enable streaming proxy.Default: 0Range: —
RTSPProxystring

RTSP Proxy Hostname

stringThe host name or IP address for the streaming proxy.Default: —Range: —
RTSPPortinteger

RTSP Proxy Port

integerThe streaming proxy port.Default: 80Range: —

Enable Gopher Proxy

integerIf 'true', enables gopher proxy.Default: 0Range: —

Gopher Proxy Hostname

stringThe host name or IP address for the gopher proxy.Default: —Range: —
GopherPortinteger

Gopher Proxy Port

integerThe gopher proxy port.Default: 80Range: —

Exceptions

arrayThe list of hosts and domains that should bypass proxy settings.Default: —Range: —
Exceptionstring

Bypassed Domain

required
stringBypass proxy settings for these Hosts & DomainsDefault: —Range: —

Enable Automatic Proxy Configuration

integerIf 'true', enables automatic proxy configuration.Default: 0Range: —

Automatic Proxy Configuration URL

stringThe automatic proxy configuration URL.

Depends on: Proxies.ProxyAutoConfigEnable ∈ [1]

Default: —Range: —

Allow Proxy PAC Fallback

integerIf '1', enables fallback. Default is '1'. For managed devices, if not supplied, the default is '0'.Default: —Range: —

Allow Proxy Bypass for Captive Portal Logins

macOS 10.9+

integerIf 1, allows client to log into captive portal network.Default: 0Range: —

SOCKS Port

integerThe SOCKS proxy port.Default: —Range: —