Back to browser

Cloudflare WARP Client

com.cloudflare.warp

Use this section to define settings for Cloudflare WARP

macOSiOS

Configuration Keys (14)

Key	Type	Title	Description	Default	Range
`display_name`	string	Display Name	When WARP is deployed with multiple organizations or configurations, this parameter is used to identify each configuration in the GUI.	—	—
`organization`	string	Organization	Required for full Cloudflare Zero Trust features. Instructs the client to register the device with your organization. Registration requires authentication via an IdP or Service Auth.	—	—
`gateway_unique_id`	string	Gateway Unique ID	Instructs the client to direct all DNS queries to a specific Gateway DNS location. This value is only necessary if deploying without a team name or in an organization with multiple DNS locations. If you do not supply a DoH subdomain, we will automatically use the default Gateway DNS location for your organization.	—	—
`service_mode`	string	Service Mode	Allows you to choose the operational mode of the client.	"warp"
`onboarding`	boolean	Onboarding	Controls the visibility of the onboarding screens that ask the user to review the privacy policy during an application's first launch.	true	—
`switch_locked`	boolean	Switch Locked	Allows the user to turn off the WARP switch and disconnect the client.	false	—
`auto_connect`	integer	Auto Connect	If switch has been turned off by user, the client will automatically turn itself back on after the specified number of minutes. We recommend keeping this set to a very low value - usually just enough time for a user to log in to hotel or airport Wi-Fi. If any value is specified for auto_connect the default state of the WARP client will always be Connected (for example, after the initial install or a reboot).	—
`support_url`	string	Support URL	When the WARP client is deployed via MDM, the in-app Send Feedback button is disabled by default. This parameter allows you to re-enable the button and direct feedback towards your organization.	—	—
`override_api_endpoint`	string	Override API Endpoint	Overrides the IP address used by the WARP client to communicate with the client orchestration API. If you set this parameter, be sure to update your organization's firewall to ensure the new IP is allowed through.	—	—
`override_doh_endpoint`	string	Override DoH Endpoint	Overrides the IP address used by the WARP client to resolve DNS queries via DNS over HTTPS (DoH). If you set this parameter, be sure to update your organization's firewall to ensure the new IP is allowed through.	—	—
`override_warp_endpoint`	string	Override WARP Endpoint	Overrides the IP address and UDP port used by the WARP client to send traffic to Cloudflare's edge. If you set this parameter, be sure to update your organization's firewall to ensure the new IP is allowed through.	—	—
`unique_client_id`	string	Unique Client ID	Assigns a unique identifier to the device for the device UUID posture check.	—	—
`auth_client_id`	string	Auth Client ID	Enrolls the device in your Zero Trust organization using a service token. Requires the auth_client_secret parameter.	—	—
`auth_client_secret`	string	Auth Client Secret	Enrolls the device in your Zero Trust organization using a service token. Requires the auth_client_id parameter.	—	—