PayloadKit

Global HTTP Proxy

com.apple.proxy.http.global

The payload that configures a global HTTP proxy.

iOS 6.0+macOS 10.9+tvOS 9.0+visionOS 2.0+
Apple schemaexclusive

Requires supervision on iOS, tvOS, visionOS · Only one instance per profile · macOS: device channel only

Configuration Keys (8)

KeyTypeDescriptionDefaultRange
ProxyTypestring

Proxy type

required
stringThe proxy type. For a manual proxy type, the profile contains the proxy server address, including its port, and optionally a user name and password. For an auto proxy type, you can enter a PAC URL.Default: "Manual"Range: Manual, Auto

Proxy server

required
stringThe proxy server's network address. The device requires this if 'ProxyType' is set to 'Manual', and ignores it if 'ProxyType' is set to 'Automatic'.

Depends on: ProxyType ∈ [Manual]

Default: —Range: —

Proxy server port

integerThe proxy server's port number. The device requires this if 'ProxyType' is set to 'Manual', and ignores this if 'ProxyType' is set to 'Automatic'.

Depends on: ProxyType ∈ [Manual]

Default: —Range: —

Proxy username

stringThe user name used to authenticate to the proxy server. The device only uses this if 'ProxyType' is set to 'Manual', and ignores it if 'ProxyType' is set to 'Automatic'.Default: —Range: —

Proxy password

stringThe password used to authenticate to the proxy server. The device only uses this if 'ProxyType' is set to 'Manual', and ignores it if 'ProxyType' is set to 'Automatic'.Default: —Range: —

Proxy PAC URL

stringThe URL of the PAC file that defines the proxy configuration. Starting in iOS 13 and macOS 10.15, only URLs that begin with 'http://' or 'https://' are allowed. This is only used if 'ProxyType' is set to 'Automatic', and is ignored if 'ProxyType' is set to 'Manual'.Default: —Range: —

Proxy PAC fallback allowed

iOS 7.0+

booleanIf 'true', allows connecting directly to the destination if the proxy autoconfiguration (PAC) file is unreachable.Default: falseRange: —

Proxy bypass allowed

iOS 7.0+

booleanIf 'true', allows the device to bypass the proxy server to display the login page for captive networks.Default: falseRange: —