Get Split Tunnel Exclude List for a Device Settings Policy

GET

https://api.cloudflare.com/client/v4/accounts/{identifier}/devices/policy/{uuid}/exclude

Last modified:2022-12-16 13:48:33

Get the list of routes excluded from the WARP client's tunnel for one specific device settings policy.

Request

Path Params

uuid

string

required

identifier

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get Split Tunnel Exclude List for a Device Settings Policy response

application/json

Body

result

required

Any of

allOf {2}

array[object (split_tunnel) {3}]

allOf {2}

One of

array[object (split_tunnel) {3}]

object

address

string

required

The address in CIDR format to exclude from the tunnel. If address is present, host must not be present.

Example:

192.0.2.0/24

description

string

required

A description of the split tunnel item, displayed in the client UI.

<= 100 characters

Example:

Exclude testing domains from the tunnel

host

string

optional

The domain name to exclude from the tunnel. If host is present, address must not be present.

Example:

*.example.com

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": [
        {
            "address": "192.0.2.0/24",
            "description": "Exclude testing domains from the tunnel",
            "host": "*.example.com"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

🟢200Get Split Tunnel Exclude List for a Device Settings Policy response failure

Modified at 2022-12-16 13:48:33

Update Device Settings Policy

Set Split Tunnel Exclude List for a Device Settings Policy