API Reference

Zero Trust

Devices

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

DEX Tests

List Device DEX tests

client.zeroTrust.devices.dexTests.list(DEXTestListParams { account_id, kind, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<DEXTestListResponse { data, enabled, interval, 5 more } >

GET/accounts/{account_id}/dex/devices/dex_tests

Get Device DEX test

client.zeroTrust.devices.dexTests.get(stringdexTestId, DEXTestGetParams { account_id } params, RequestOptionsoptions?): DEXTestGetResponse { data, enabled, interval, 5 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?): DEXTestCreateResponse { data, enabled, interval, 5 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?): DEXTestUpdateResponse { data, enabled, interval, 5 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?: string

The type of test.

method?: string

The HTTP request method type.

SchemaHTTP { data, enabled, interval, 5 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.

description?: string

Additional details about the test.

target_policies?: Array<TargetPolicy>

Device settings profiles targeted by this test.

id?: string

The id of the device settings profile.

default?: boolean

Whether the profile is the account default.

name?: string

The name of the device settings profile.

targeted?: boolean

test_id?: string

The unique identifier for the test.

maxLength32

DEXTestListResponse { data, enabled, interval, 5 more }

data: Data { 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.

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.

description?: string

Additional details about the test.

target_policies?: Array<TargetPolicy>

DEX rules targeted by this test

id: string

API Resource UUID tag.

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

DEXTestGetResponse { data, enabled, interval, 5 more }

data: Data { 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.

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.

description?: string

Additional details about the test.

target_policies?: Array<TargetPolicy>

DEX rules targeted by this test

id: string

API Resource UUID tag.

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

DEXTestCreateResponse { data, enabled, interval, 5 more }

data: Data { 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.

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.

description?: string

Additional details about the test.

target_policies?: Array<TargetPolicy>

DEX rules targeted by this test

id: string

API Resource UUID tag.

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

DEXTestUpdateResponse { data, enabled, interval, 5 more }

data: Data { 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.

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.

description?: string

Additional details about the test.

target_policies?: Array<TargetPolicy>

DEX rules targeted by this test

id: string

API Resource UUID tag.

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

DEXTestDeleteResponse { dex_tests }

dex_tests?: Array<DEXTest>

data: Data { 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.

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.

description?: string

Additional details about the test.

target_policies?: Array<TargetPolicy>

DEX rules targeted by this test

id: string

API Resource UUID tag.

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