commands_devices

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

Overview

Name	commands_devices
Type	Resource
Id	cloudflare.zero_trust.commands_devices

Fields

The following fields are returned by SELECT queries:

list

List of eligible devices

Name	Datatype	Description
deviceId	string	Device identifier (UUID v4)
deviceName	string	Device identifier (human readable)
eligible	boolean	Whether the device is eligible for remote captures
ineligibleReason	string	If the device is not eligible, the reason why.
personEmail	string	User contact email address
platform	string	Operating system (example: windows)
registrationId	string	Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user's registration on the device.
status	string	Network status (example: connected)
timestamp	string	Timestamp in ISO format (example: 2023-10-11T00:00:00Z)
version	string	WARP client version (example: 1.0.0)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id	page, per_page, search	List devices with WARP client support for remote captures which have been connected in the last 1 hour.

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.
page	number	Page number of paginated results
per_page	number	Number of items per page
search	string	Filter devices by name or email

SELECT examples

list

List devices with WARP client support for remote captures which have been connected in the last 1 hour.

SELECT
deviceId,
deviceName,
eligible,
ineligibleReason,
personEmail,
platform,
registrationId,
status,
timestamp,
version
FROM cloudflare.zero_trust.commands_devices
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND search = '{{ search }}'
;