Skip to main content

default

Creates, updates, deletes, gets or lists a default resource.

Overview

Namedefault
TypeResource
Idcloudflare.zero_trust.default

Fields

The following fields are returned by SELECT queries:

Get the default device settings profile response.

NameDatatypeDescription
gateway_unique_idstring (example: 699d98642c564d2e855e9661899b7252)
policy_idstring (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
allow_mode_switchbooleanWhether to allow the user to switch WARP between modes.
allow_updatesbooleanWhether to receive update notifications when a new version of the client is available.
allowed_to_leavebooleanWhether to allow devices to leave the organization.
auto_connectnumberThe amount of time in seconds to reconnect after having been disabled.
captive_portalnumberTurn on the captive portal after the specified amount of time.
defaultbooleanWhether the policy will be applied to matching devices.
disable_auto_fallbackbooleanIf 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 to true.
enabledbooleanWhether the policy will be applied to matching devices.
excludearrayList of routes excluded in the WARP client's tunnel.
exclude_office_ipsbooleanWhether to add Microsoft IPs to Split Tunnel exclusions.
fallback_domainsarray
includearrayList of routes included in the WARP client's tunnel.
register_interface_ip_with_dnsbooleanDetermines if the operating system will register WARP's local interface IP with your on-premises DNS server.
sccm_vpn_boundary_supportbooleanDetermines whether the WARP client indicates to SCCM that it is inside a VPN boundary. (Windows only).
service_mode_v2object (x-stainless-terraform-configurability: computed_optional)
support_urlstringThe URL to launch when the Send Feedback button is clicked. (default: , example: https://1.1.1.1/help)
switch_lockedbooleanWhether to allow the user to turn off the WARP switch and disconnect the client.
tunnel_protocolstringDetermines which tunnel protocol to use. (default: , example: wireguard)
virtual_networksobjectVirtual network access settings for the device.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectaccount_idFetches the default device settings profile for an account.
editupdateaccount_idUpdates the default device settings profile for an account.

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.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.

SELECT examples

Fetches the default device settings profile for an account.

SELECT
gateway_unique_id,
policy_id,
allow_mode_switch,
allow_updates,
allowed_to_leave,
auto_connect,
captive_portal,
default,
disable_auto_fallback,
enabled,
exclude,
exclude_office_ips,
fallback_domains,
include,
register_interface_ip_with_dns,
sccm_vpn_boundary_support,
service_mode_v2,
support_url,
switch_locked,
tunnel_protocol,
virtual_networks
FROM cloudflare.zero_trust.default
WHERE account_id = '{{ account_id }}' -- required
;

UPDATE examples

Updates the default device settings profile for an account.

UPDATE cloudflare.zero_trust.default
SET
allow_mode_switch = {{ allow_mode_switch }},
allow_updates = {{ allow_updates }},
allowed_to_leave = {{ allowed_to_leave }},
auto_connect = {{ auto_connect }},
captive_portal = {{ captive_portal }},
disable_auto_fallback = {{ disable_auto_fallback }},
exclude = '{{ exclude }}',
exclude_office_ips = {{ exclude_office_ips }},
include = '{{ include }}',
lan_allow_minutes = {{ lan_allow_minutes }},
lan_allow_subnet_size = {{ lan_allow_subnet_size }},
register_interface_ip_with_dns = {{ register_interface_ip_with_dns }},
sccm_vpn_boundary_support = {{ sccm_vpn_boundary_support }},
service_mode_v2 = '{{ service_mode_v2 }}',
support_url = '{{ support_url }}',
switch_locked = {{ switch_locked }},
tunnel_protocol = '{{ tunnel_protocol }}',
virtual_networks = '{{ virtual_networks }}'
WHERE
account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;