devices

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

Overview

Name	devices
Type	Resource
Id	cloudflare.zero_trust.devices

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
delete	delete	device_id, account_id		Deletes a WARP device.
create_networks	exec	account_id, name, type, config		Creates a new device managed network.
delete_policy	exec	policy_id, account_id		Deletes a device settings profile and fetches a list of the remaining profiles for an account.
update_policy	exec	policy_id, account_id		Updates a configured device settings profile.
unrevoke	exec	account_id		Unrevokes a list of devices. Not supported when multi-user mode is enabled. Deprecated: please use POST /accounts/{account_id}/devices/registrations/unrevoke instead.

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.
device_id	string
policy_id	string	The Access policy ID.

DELETE examples

delete

Deletes a WARP device.

DELETE FROM cloudflare.zero_trust.devices
WHERE device_id = '{{ device_id }}' --required
AND account_id = '{{ account_id }}' --required
;

Lifecycle Methods

create_networks

Creates a new device managed network.

EXEC cloudflare.zero_trust.devices.create_networks 
@account_id='{{ account_id }}' --required 
@@json=
'{
"config": "{{ config }}", 
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

delete_policy

Deletes a device settings profile and fetches a list of the remaining profiles for an account.

EXEC cloudflare.zero_trust.devices.delete_policy 
@policy_id='{{ policy_id }}' --required, 
@account_id='{{ account_id }}' --required
;

update_policy

Updates a configured device settings profile.

EXEC cloudflare.zero_trust.devices.update_policy 
@policy_id='{{ policy_id }}' --required, 
@account_id='{{ account_id }}' --required 
@@json=
'{
"allow_mode_switch": {{ allow_mode_switch }}, 
"allow_updates": {{ allow_updates }}, 
"allowed_to_leave": {{ allowed_to_leave }}, 
"auto_connect": {{ auto_connect }}, 
"captive_portal": {{ captive_portal }}, 
"description": "{{ description }}", 
"disable_auto_fallback": {{ disable_auto_fallback }}, 
"enabled": {{ enabled }}, 
"exclude": "{{ exclude }}", 
"exclude_office_ips": {{ exclude_office_ips }}, 
"include": "{{ include }}", 
"lan_allow_minutes": {{ lan_allow_minutes }}, 
"lan_allow_subnet_size": {{ lan_allow_subnet_size }}, 
"match": "{{ match }}", 
"name": "{{ name }}", 
"precedence": {{ precedence }}, 
"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 }}"
}'
;

unrevoke

Unrevokes a list of devices. Not supported when multi-user mode is enabled. Deprecated: please use POST /accounts/{account_id}/devices/registrations/unrevoke instead.

EXEC cloudflare.zero_trust.devices.unrevoke 
@account_id='{{ account_id }}' --required
;