Parameters

Each client supports the following set of parameters as part of their deployment, regardless of the deployment mechanism.

Note

Most of the parameters listed below are also configurable in Zero Trust under Settings > Devices. In the event of conflicting settings, the WARP client will always give precedence to settings on the local device (for example, in your mdm.xml or com.cloudflare.warp.plist files).

Required for full Cloudflare Zero Trust features

For the majority of Cloudflare Zero Trust features to work, you need to specify a team name. Examples of Cloudflare Zero Trust features which depend on the team name are HTTP policies, Browser Isolation, and device posture.

organization

Instructs the client to register the device with your organization. Registration requires authentication via an IdP or Service Auth.

Value Type: string

Value: Your team name.

Required for DNS-only policy enforcement

This field is used to enforce DNS policies when deploying the client in DoH-only mode.

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.

Value Type: string

Value: Your DoH subdomain.

Optional fields

service_mode

Allows you to choose the operational mode of the client.

Value Type: string

Value:

• warp — (default) Gateway with WARP.
• 1dot1 — Gateway with DoH.
• proxy — Proxy mode. Use the proxy_port parameter to specify the localhost SOCKS proxy port (between 0-66535). For example,

  <key>service_mode</key>
  <string>proxy</string>
  <key>proxy_port</key>
  <integer>44444</integer>

• postureonly — Device Information Only.

The service mode Secure Web Gateway without DNS filtering is not currently supported as a value and must be configured in Zero Trust.

onboarding

Controls the visibility of the onboarding screens that ask the user to review the privacy policy during an application's first launch.

Value Type: boolean

Value:

• false — Screens hidden.
• true — (default) Screens visible.

switch_locked

Allows the user to turn off the WARP switch and disconnect the client.

Value Type: boolean

Value:

• false — (default) The user is able to turn the switch on/off at their discretion. When the switch is off, the user will not have the ability to reach sites protected by Access that leverage certain device posture checks.
• true — The user is prevented from turning off the switch. The WARP client will automatically start in the connected state.

On new deployments, you must also include the auto_connect parameter with at least a value of 0. This will prevent clients from being deployed in the off state without a way for users to manually enable them.

Note

This parameter replaces the old enabled property, which can no longer be used in conjunction with the new switch_locked and auto_connect. If you want to use these parameters, you must remove enabled.

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).

Value Type: integer

Value:

• 0 — Allow the switch to stay in the off position indefinitely until the user turns it back on.
• 1 to 1440 — Turn switch back on automatically after the specified number of minutes.

Note

This parameter replaces the old enabled property, which can no longer be used in conjunction with the new switch_locked and auto_connect. If you want to use these parameters, you must remove enabled.

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.

Value Type: string

Value:

• https://<support.example.com> — Use an https:// link to open your company's internal help site.
• mailto:<yoursupport@example.com> — Use a mailto: link to open your default mail client.

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.

This functionality is intended for use with a Cloudflare China local network partner or any other third-party network partner that can maintain the integrity of network traffic. Most IT admins should not set this setting as it will redirect all API traffic to a new IP.

Value Type: string

Value: 1.2.3.4 — Redirect all client orchestration API calls to 1.2.3.4.

The string must be a valid IPv4 or IPv6 address, otherwise the WARP client will fail to parse the entire MDM file.

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.

This functionality is intended for use with a Cloudflare China local network partner or any other third-party network partner that can maintain the integrity of network traffic. Most IT admins should not set this setting as it will redirect all DoH traffic to a new IP.

Value Type: string

Value: 1.2.3.4 — Redirect all DNS over HTTPS lookups to 1.2.3.4.

The string must be a valid IPv4 or IPv6 address, otherwise the WARP client will fail to parse the entire MDM file.

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.

This functionality is intended for use with a Cloudflare China local network partner or any other third-party network partner that can maintain the integrity of network traffic. Most IT admins should not set this setting as it will redirect all WARP traffic to a new IP.

Value Type: string

Value: 203.0.113.0:500 — Redirect all WARP traffic to 203.0.113.0 on port 500.

The string must be a valid IPv4 or IPv6 socket address (containing the IP address and port number), otherwise the WARP client will fail to parse the entire MDM file.

unique_client_id

Assigns a unique identifier to the device for the device UUID posture check.

Value Type: string

Value: UUID for the device (for example, 496c6124-db89-4735-bc4e-7f759109a6f1).

auth_client_id

Enrolls the device in your Zero Trust organization using a service token. Requires the auth_client_secret parameter.

Value Type: string

Value: Client ID of the service token.

Example configuration:

<key>auth_client_id</key>
<string>88bf3b6d86161464f6509f7219099e57.access</string>
<key>auth_client_secret</key>
<string>bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5</string>

auth_client_secret

Enrolls the device in your Zero Trust organization using a service token. Requires the auth_client_id parameter.

Value Type: string

Value: Client Secret of the service token.

display_name

When WARP is deployed with multiple organizations or configurations, this parameter is used to identify each configuration in the GUI.

Value Type: string

Value: Configuration name shown in the GUI (for example, Test environment).

Was this helpful?

What did you like?

Accurate

Easy to understand

Solved my problem

Helped me decide to use the product

Other

What went wrong?

Hard to understand

Incorrect information

Missing the information

Other

Thank you for helping improve Cloudflare's documentation!