List Device Settings Policies

Lists the device settings policies for an account.

application/json

Body

result

required

Any of

allOf {2}

array[object (device_settings_policy) {20}]

allOf {2}

One of

array[object (device_settings_policy) {20}]

object

allow_mode_switch

boolean

allow_mode_switch

optional

Whether to allow the user to switch WARP between modes.

Example:

true

allow_updates

boolean

allow_updates

optional

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

Example:

true

allowed_to_leave

boolean

allowed_to_leave

optional

Whether to allow devices to leave the organization.

Example:

true

auto_connect

number

auto_connect

optional

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

Example:

captive_portal

number

captive_portal

optional

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

Example:

180

default

boolean

schemas-default

optional

Whether the policy is the default policy for an account.

Example:

false

description

string

devices_components-schemas-description

optional

A description of the policy.

<= 500 characters

Example:

Policy for test teams.

disable_auto_fallback

boolean

disable_auto_fallback

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

exclude

array[object (split_tunnel) {3}]

components-schemas-exclude

optional

fallback_domains

array[object (fallback_domain) {3}]

fallback_domains

optional

gateway_unique_id

string

gateway_unique_id

optional

Example:

699d98642c564d2e855e9661899b7252

include

array[object (split_tunnel_include) {3}]

schemas-include

optional

match

string

components-schemas-match

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

policy_id

string

uuid

read-onlyoptional

UUID

<= 36 characters

Example:

f174e90a-fafe-4643-bbbc-4a0ed4fc8415

precedence

number

components-schemas-precedence

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

support_url

string

support_url

optional

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

Example:

https://1.1.1.1/help

switch_locked

boolean

switch_locked

optional

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

Example:

true

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "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
    }
}

List Device Settings Policies

Request

Request samples

Responses