excludes

Creates, updates, deletes, gets or lists an excludes resource.

Overview

Name	excludes
Type	Resource
Id	cloudflare.zero_trust.excludes

Fields

The following fields are returned by SELECT queries:

list_by_policy

Get the Split Tunnel exclude list for a device settings profile response.

Name	Datatype	Description
address	string	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, x-stainless-terraform-configurability: computed_optional)
description	string	A description of the Split Tunnel item, displayed in the client UI. (example: Exclude testing domains from the tunnel, x-stainless-terraform-configurability: computed_optional)
host	string	The domain name to exclude from the tunnel. If host is present, address must not be present. (example: *.example.com, x-stainless-terraform-configurability: computed_optional)

list_by_account

Get the Split Tunnel exclude list response.

Name	Datatype	Description
address	string	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, x-stainless-terraform-configurability: computed_optional)
description	string	A description of the Split Tunnel item, displayed in the client UI. (example: Exclude testing domains from the tunnel, x-stainless-terraform-configurability: computed_optional)
host	string	The domain name to exclude from the tunnel. If host is present, address must not be present. (example: *.example.com, x-stainless-terraform-configurability: computed_optional)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_policy	select	policy_id, account_id		Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
list_by_account	select	account_id		Fetches the list of routes excluded from the WARP client's tunnel.
set_by_policy	replace	policy_id, account_id		Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
set	replace	account_id		Sets the list of routes excluded from the WARP client's tunnel.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
policy_id	string	The Access policy ID.

SELECT examples

list_by_policy

Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

SELECT
address,
description,
host
FROM cloudflare.zero_trust.excludes
WHERE policy_id = '{{ policy_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list_by_account

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

SELECT
address,
description,
host
FROM cloudflare.zero_trust.excludes
WHERE account_id = '{{ account_id }}' -- required
;

REPLACE examples

set_by_policy

Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

REPLACE cloudflare.zero_trust.excludes
SET 
-- No updatable properties
WHERE 
policy_id = '{{ policy_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

set

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

REPLACE cloudflare.zero_trust.excludes
SET 
-- No updatable properties
WHERE 
account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;