Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Devices

DEX Tests

List Device DEX tests
client.zeroTrust.devices.dexTests.list(DEXTestListParams { account_id, kind, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<SchemaHTTP { data, enabled, interval, 7 more } >
GET/accounts/{account_id}/dex/devices/dex_tests
Get Device DEX test
client.zeroTrust.devices.dexTests.get(stringdexTestID, DEXTestGetParams { account_id } params, RequestOptionsoptions?): SchemaHTTP { data, enabled, interval, 7 more }
GET/accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}
Create Device DEX test
client.zeroTrust.devices.dexTests.create(DEXTestCreateParams { account_id, data, enabled, 5 more } params, RequestOptionsoptions?): SchemaHTTP { data, enabled, interval, 7 more }
POST/accounts/{account_id}/dex/devices/dex_tests
Update Device DEX test
client.zeroTrust.devices.dexTests.update(stringdexTestID, DEXTestUpdateParams { account_id, data, enabled, 5 more } params, RequestOptionsoptions?): SchemaHTTP { data, enabled, interval, 7 more }
PUT/accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}
Delete Device DEX test
client.zeroTrust.devices.dexTests.delete(stringdexTestID, DEXTestDeleteParams { account_id } params, RequestOptionsoptions?): DEXTestDeleteResponse { dex_tests }
DELETE/accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}
ModelsExpand Collapse
SchemaData { host, kind, method }

The configuration object which contains the details for the WARP client to conduct the test.

host: string

The desired endpoint to test.

kind: "http" | "traceroute"

The type of test.

One of the following:
"http"
"traceroute"
method?: "GET"

The HTTP request method type.

SchemaHTTP { data, enabled, interval, 7 more }
data: SchemaData { host, kind, method }

The configuration object which contains the details for the WARP client to conduct the test.

enabled: boolean

Determines whether or not the test is active.

interval: string

How often the test will run.

name: string

The name of the DEX test. Must be unique.

created?: string

Date the test was created, in RFC 3339 format.

formatdate-time
description?: string

Additional details about the test.

target_policies?: Array<TargetPolicy>

DEX rules targeted by this test

id: string

The id of the DEX rule.

maxLength36
default?: boolean

Whether the DEX rule is the account default.

name?: string

The name of the DEX rule.

targeted?: boolean
test_id?: string

The unique identifier for the test.

maxLength32
updated?: string

Date the test was last updated, in RFC 3339 format.

formatdate-time
DEXTestDeleteResponse { dex_tests }
dex_tests?: Array<SchemaHTTP { data, enabled, interval, 7 more } >
data: SchemaData { host, kind, method }

The configuration object which contains the details for the WARP client to conduct the test.

enabled: boolean

Determines whether or not the test is active.

interval: string

How often the test will run.

name: string

The name of the DEX test. Must be unique.

created?: string

Date the test was created, in RFC 3339 format.

formatdate-time
description?: string

Additional details about the test.

target_policies?: Array<TargetPolicy>

DEX rules targeted by this test

id: string

The id of the DEX rule.

maxLength36
default?: boolean

Whether the DEX rule is the account default.

name?: string

The name of the DEX rule.

targeted?: boolean
test_id?: string

The unique identifier for the test.

maxLength32
updated?: string

Date the test was last updated, in RFC 3339 format.

formatdate-time