Cloudflare WARP Client
com.cloudflare.warp
Use this section to define settings for Cloudflare WARP
macOSiOS
Configuration Keys (14)
Showing 14 of 14 keys
| Key | Type | Description | Default | Range |
|---|---|---|---|---|
display_namestringDisplay Name | string | When WARP is deployed with multiple organizations or configurations, this parameter is used to identify each configuration in the GUI. | Default: — | Range: — |
organizationstringOrganization | string | 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. | Default: — | Range: — |
gateway_unique_idstringGateway Unique ID | string | 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. | Default: — | Range: — |
service_modestringService Mode | string | Allows you to choose the operational mode of the client. | Default: "warp" | Range: DoH Only (1dot1), WARP (warp) |
onboardingbooleanOnboarding | boolean | Controls the visibility of the onboarding screens that ask the user to review the privacy policy during an application's first launch. | Default: true | Range: — |
switch_lockedbooleanSwitch Locked | boolean | Allows the user to turn off the WARP switch and disconnect the client. | Default: false | Range: — |
auto_connectintegerAuto Connect | integer | 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). | Default: — | Range: 0 – 1440 |
support_urlstringSupport URL | string | 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. | Default: — | Range: — |
override_api_endpointstringOverride API Endpoint | string | 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. | Default: — | Range: — |
override_doh_endpointstringOverride DoH Endpoint | string | 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. | Default: — | Range: — |
override_warp_endpointstringOverride WARP Endpoint | string | 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. | Default: — | Range: — |
unique_client_idstringUnique Client ID | string | Assigns a unique identifier to the device for the device UUID posture check. | Default: — | Range: — |
auth_client_idstringAuth Client ID | string | Enrolls the device in your Zero Trust organization using a service token. Requires the auth_client_secret parameter. | Default: — | Range: — |
auth_client_secretstringAuth Client Secret | string | Enrolls the device in your Zero Trust organization using a service token. Requires the auth_client_id parameter. | Default: — | Range: — |