API Reference

Zero Trust

DEX

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rules

Get DEX Rule

client.zeroTrust.dex.rules.get(stringruleId, RuleGetParams { account_id } params, RequestOptionsoptions?): RuleGetResponse { id, created_at, match, 4 more }

GET/accounts/{account_id}/dex/rules/{rule_id}

Delete a DEX Rule

client.zeroTrust.dex.rules.delete(stringruleId, RuleDeleteParams { account_id } params, RequestOptionsoptions?): RuleDeleteResponse | null

DELETE/accounts/{account_id}/dex/rules/{rule_id}

Update a DEX Rule

client.zeroTrust.dex.rules.update(stringruleId, RuleUpdateParams { account_id, description, match, name } params, RequestOptionsoptions?): RuleUpdateResponse { id, created_at, match, 4 more }

PATCH/accounts/{account_id}/dex/rules/{rule_id}

Create a DEX Rule

client.zeroTrust.dex.rules.create(RuleCreateParams { account_id, match, name, description } params, RequestOptionsoptions?): RuleCreateResponse { id, created_at, match, 4 more }

POST/accounts/{account_id}/dex/rules

List DEX Rules

client.zeroTrust.dex.rules.list(RuleListParams { account_id, page, per_page, 3 more } params, RequestOptionsoptions?): V4PagePagination<RuleListResponse { rules } >

GET/accounts/{account_id}/dex/rules

ModelsExpand Collapse

RuleGetResponse { id, created_at, match, 4 more }

id: string

API Resource UUID tag.

maxLength36

created_at: string

match: string

name: string

description?: string

targeted_tests?: Array<TargetedTest>

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

name: string

test_id: string

updated_at?: string

RuleDeleteResponse = boolean | null

RuleUpdateResponse { id, created_at, match, 4 more }

id: string

API Resource UUID tag.

maxLength36

created_at: string

match: string

name: string

description?: string

targeted_tests?: Array<TargetedTest>

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

name: string

test_id: string

updated_at?: string

RuleCreateResponse { id, created_at, match, 4 more }

id: string

API Resource UUID tag.

maxLength36

created_at: string

match: string

name: string

description?: string

targeted_tests?: Array<TargetedTest>

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

name: string

test_id: string

updated_at?: string

RuleListResponse { rules }

rules?: Array<Rule>

id: string

API Resource UUID tag.

maxLength36

created_at: string

match: string

name: string

description?: string

targeted_tests?: Array<TargetedTest>

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

name: string

test_id: string

updated_at?: string