Update Device Settings Policy

Update a device settings policy.

Request

Path Params

uuid

string

required

identifier

string

required

Body Params application/json

allow_mode_switch

boolean

optional

Whether to allow the user to switch WARP between modes.

Example:

true

allow_updates

boolean

optional

Whether to receive update notifications when a new version of the client is available.

Example:

true

allowed_to_leave

boolean

optional

Whether to allow devices to leave the organization.

Example:

true

auto_connect

number

optional

The amount of time in minutes to reconnect after having been disabled.

Example:

captive_portal

number

optional

Turn on the captive portal after the specified amount of time.

Example:

180

description

string

optional

A description of the policy.

<= 500 characters

Example:

Policy for test teams.

disable_auto_fallback

boolean

optional

If the dns_server field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers, unless this policy option is set.

Example:

true

enabled

boolean

optional

Whether the policy will be applied to matching devices.

Example:

true

match

string

optional

The wirefilter expression to match devices.

<= 500 characters

Example:

user.identity == "test@cloudflare.com"

name

string

optional

The name of the device settings policy.

<= 100 characters

Example:

Allow Developers

precedence

number

optional

The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.

Example:

100

service_mode_v2

object (service_mode_v2)

optional

mode

string

optional

The mode to run the WARP client under.

Example:

proxy

port

number

optional

The port number when used with proxy mode.

Example:

3000

support_url

string

optional

The URL to launch when the Send Feedback button is clicked.

Example:

https://1.1.1.1/help

switch_locked

boolean

optional

Whether to allow the user to turn off the WARP switch and disconnect the client.

Example:

true

Example

{
    "allow_mode_switch": true,
    "allow_updates": true,
    "allowed_to_leave": true,
    "auto_connect": 0,
    "captive_portal": 180,
    "description": "Policy for test teams.",
    "disable_auto_fallback": true,
    "enabled": true,
    "match": "user.identity == \"test@cloudflare.com\"",
    "name": "Allow Developers",
    "precedence": 100,
    "service_mode_v2": {
        "mode": "proxy",
        "port": 3000
    },
    "support_url": "https://1.1.1.1/help",
    "switch_locked": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Update Device Settings Policy response

application/json

Body

allOf {2}

optional

object (api-response-collection)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

object

optional

result

object (device_settings_policy)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "0": null,
        "allow_mode_switch": true,
        "allow_updates": true,
        "allowed_to_leave": true,
        "auto_connect": 0,
        "captive_portal": 180,
        "default": false,
        "description": "Policy for test teams.",
        "disable_auto_fallback": true,
        "enabled": true,
        "exclude": [
            {
                "address": "192.0.2.0/24",
                "description": "Exclude testing domains from the tunnel",
                "host": "*.example.com"
            }
        ],
        "fallback_domains": [
            {
                "description": "Domain bypass for local development",
                "dns_server": [
                    null
                ],
                "suffix": "example.com"
            }
        ],
        "gateway_unique_id": "699d98642c564d2e855e9661899b7252",
        "include": [
            {
                "address": "192.0.2.0/24",
                "description": "Include testing domains from the tunnel",
                "host": "*.example.com"
            }
        ],
        "match": "user.identity == \"test@cloudflare.com\"",
        "name": "Allow Developers",
        "policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "precedence": 100,
        "service_mode_v2": {
            "mode": "proxy",
            "port": 3000
        },
        "support_url": "https://1.1.1.1/help",
        "switch_locked": true
    },
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

🟢200Update Device Settings Policy response failure