default
Creates, updates, deletes, gets or lists a default resource.
Overview
| Name | default |
| Type | Resource |
| Id | cloudflare.zero_trust.default |
Fields
The following fields are returned by SELECT queries:
- list
Get the default device settings profile response.
| Name | Datatype | Description |
|---|---|---|
gateway_unique_id | string | (example: 699d98642c564d2e855e9661899b7252) |
policy_id | string | (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415) |
allow_mode_switch | boolean | Whether to allow the user to switch WARP between modes. |
allow_updates | boolean | Whether to receive update notifications when a new version of the client is available. |
allowed_to_leave | boolean | Whether to allow devices to leave the organization. |
auto_connect | number | The amount of time in seconds to reconnect after having been disabled. |
captive_portal | number | Turn on the captive portal after the specified amount of time. |
default | boolean | Whether the policy will be applied to matching devices. |
disable_auto_fallback | boolean | 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 to true. |
enabled | boolean | Whether the policy will be applied to matching devices. |
exclude | array | List of routes excluded in the WARP client's tunnel. |
exclude_office_ips | boolean | Whether to add Microsoft IPs to Split Tunnel exclusions. |
fallback_domains | array | |
include | array | List of routes included in the WARP client's tunnel. |
register_interface_ip_with_dns | boolean | Determines if the operating system will register WARP's local interface IP with your on-premises DNS server. |
sccm_vpn_boundary_support | boolean | Determines whether the WARP client indicates to SCCM that it is inside a VPN boundary. (Windows only). |
service_mode_v2 | object | (x-stainless-terraform-configurability: computed_optional) |
support_url | string | The URL to launch when the Send Feedback button is clicked. (default: , example: https://1.1.1.1/help) |
switch_locked | boolean | Whether to allow the user to turn off the WARP switch and disconnect the client. |
tunnel_protocol | string | Determines which tunnel protocol to use. (default: , example: wireguard) |
virtual_networks | object | Virtual network access settings for the device. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | account_id | Fetches the default device settings profile for an account. | |
edit | update | account_id | Updates 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.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
SELECT examples
- list
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
- edit
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;