devices_settings

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

Overview

Name	devices_settings
Type	Resource
Id	cloudflare.zero_trust.devices_settings

Fields

The following fields are returned by SELECT queries:

list

Get device settings for a Zero Trust account response.

Name	Datatype	Description
disable_for_time	number	Sets the time limit, in seconds, that a user can use an override code to bypass WARP.
external_emergency_signal_enabled	boolean	Controls whether the external emergency disconnect feature is enabled.
external_emergency_signal_fingerprint	string	The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url. If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value. (example: abcd1234567890abcd1234567890abcd1234567890abcd1234567890abcd1234)
external_emergency_signal_interval	string	The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds. (example: 5m)
external_emergency_signal_url	string	The HTTPS URL from which to fetch the emergency disconnect signal. Must use HTTPS and have an IPv4 or IPv6 address as the host. (example: https://192.0.2.1/signal)
gateway_proxy_enabled	boolean	Enable gateway proxy filtering on TCP.
gateway_udp_proxy_enabled	boolean	Enable gateway proxy filtering on UDP.
root_certificate_installation_enabled	boolean	Enable installation of cloudflare managed root certificate.
use_zt_virtual_ip	boolean	Enable using CGNAT virtual IPv4.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id		Describes the current device settings for a Zero Trust account.
edit	update	account_id		Patches the current device settings for a Zero Trust account.
update	replace	account_id		Updates the current device settings for a Zero Trust account.
delete	delete	account_id		Resets the current device settings for a Zero Trust 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

Describes the current device settings for a Zero Trust account.

SELECT
disable_for_time,
external_emergency_signal_enabled,
external_emergency_signal_fingerprint,
external_emergency_signal_interval,
external_emergency_signal_url,
gateway_proxy_enabled,
gateway_udp_proxy_enabled,
root_certificate_installation_enabled,
use_zt_virtual_ip
FROM cloudflare.zero_trust.devices_settings
WHERE account_id = '{{ account_id }}' -- required
;

UPDATE examples

edit

Patches the current device settings for a Zero Trust account.

UPDATE cloudflare.zero_trust.devices_settings
SET 
disable_for_time = {{ disable_for_time }},
external_emergency_signal_enabled = {{ external_emergency_signal_enabled }},
external_emergency_signal_fingerprint = '{{ external_emergency_signal_fingerprint }}',
external_emergency_signal_interval = '{{ external_emergency_signal_interval }}',
external_emergency_signal_url = '{{ external_emergency_signal_url }}',
gateway_proxy_enabled = {{ gateway_proxy_enabled }},
gateway_udp_proxy_enabled = {{ gateway_udp_proxy_enabled }},
root_certificate_installation_enabled = {{ root_certificate_installation_enabled }},
use_zt_virtual_ip = {{ use_zt_virtual_ip }}
WHERE 
account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

update

Updates the current device settings for a Zero Trust account.

REPLACE cloudflare.zero_trust.devices_settings
SET 
disable_for_time = {{ disable_for_time }},
external_emergency_signal_enabled = {{ external_emergency_signal_enabled }},
external_emergency_signal_fingerprint = '{{ external_emergency_signal_fingerprint }}',
external_emergency_signal_interval = '{{ external_emergency_signal_interval }}',
external_emergency_signal_url = '{{ external_emergency_signal_url }}',
gateway_proxy_enabled = {{ gateway_proxy_enabled }},
gateway_udp_proxy_enabled = {{ gateway_udp_proxy_enabled }},
root_certificate_installation_enabled = {{ root_certificate_installation_enabled }},
use_zt_virtual_ip = {{ use_zt_virtual_ip }}
WHERE 
account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Resets the current device settings for a Zero Trust account.

DELETE FROM cloudflare.zero_trust.devices_settings
WHERE account_id = '{{ account_id }}' --required
;