Search + K

Command Palette

Search for a command to run...

Sign In

Set the Split Tunnel exclude list

PUT /accounts/{account_id}/devices/policy/exclude
Copy endpoint
https://api.cloudflare.com/client/v4

Sets the list of routes excluded from the WARP client's tunnel.

Parameters

path Path Parameters

Name Type
account_id required
type TeamsDevicesIdentifier = unknown

Request Body

application/json required
type TeamsDevicesSplitTunnel = interface TeamsDevicesExcludeSplitTunnelWithAddress {
address: TeamsDevicesSplitTunnelAddress

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

type TeamsDevicesSplitTunnelAddress = string
;
description?: TeamsDevicesSplitTunnelDescription

A description of the Split Tunnel item, displayed in the client UI.

type TeamsDevicesSplitTunnelDescription = string
;
}
& {}
| interface TeamsDevicesExcludeSplitTunnelWithHost {
description?: TeamsDevicesSplitTunnelDescription

A description of the Split Tunnel item, displayed in the client UI.

type TeamsDevicesSplitTunnelDescription = string
;
host: TeamsDevicesSplitTunnelHost

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

type TeamsDevicesSplitTunnelHost = string
;
}
& {}
[]

Responses

200 application/json

Set the Split Tunnel exclude list response.

type TeamsDevicesSplitTunnelResponseCollection = type TeamsDevicesApiResponseCollection = never & { result?: TeamsDevicesSplitTunnel
type TeamsDevicesSplitTunnel = TeamsDevicesExcludeSplitTunnelWithAddress & {} | TeamsDevicesExcludeSplitTunnelWithHost & {}
[]
; }

Client Errors

4XX application/json

Set the Split Tunnel exclude list response failure.

type TeamsDevicesSplitTunnelResponseCollection = type TeamsDevicesApiResponseCollection = never & { result?: TeamsDevicesSplitTunnel
type TeamsDevicesSplitTunnel = TeamsDevicesExcludeSplitTunnelWithAddress & {} | TeamsDevicesExcludeSplitTunnelWithHost & {}
[]
; }
& interface TeamsDevicesApiResponseCommonFailure {
errors: TeamsDevicesMessages
type TeamsDevicesMessages = { code: number;message: string; }[]
;
messages: TeamsDevicesMessages
type TeamsDevicesMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}