tests
Creates, updates, deletes, gets or lists a tests resource.
Overview
| Name | tests |
| Type | Resource |
| Id | cloudflare.zero_trust.tests |
Fields
The following fields are returned by SELECT queries:
- list
success response
| Name | Datatype | Description |
|---|---|---|
overviewMetrics | object | |
tests | array | array of test results objects. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | account_id | colo, testName, deviceId, registration_id, page, per_page, kind | List DEX tests with overview metrics |
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. |
colo | string | Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. |
deviceId | array | Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. |
kind | string | Filter by test type |
page | number | Page number of paginated results |
per_page | number | Number of items per page |
registration_id | string | Optionally filter results to a specific device registration. Must be used in combination with a single deviceId. |
testName | string | Optionally filter results by test name |
SELECT examples
- list
List DEX tests with overview metrics
SELECT
overviewMetrics,
tests
FROM cloudflare.zero_trust.tests
WHERE account_id = '{{ account_id }}' -- required
AND colo = '{{ colo }}'
AND testName = '{{ testName }}'
AND deviceId = '{{ deviceId }}'
AND registration_id = '{{ registration_id }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND kind = '{{ kind }}'
;