Skip to content
Start here

Rules

Get DEX Rule
GET/accounts/{account_id}/dex/rules/{rule_id}
Delete a DEX Rule
DELETE/accounts/{account_id}/dex/rules/{rule_id}
Update a DEX Rule
PATCH/accounts/{account_id}/dex/rules/{rule_id}
Create a DEX Rule
POST/accounts/{account_id}/dex/rules
List DEX Rules
GET/accounts/{account_id}/dex/rules
ModelsExpand Collapse
RuleGetResponse object { id, created_at, match, 4 more }
id: string

API Resource UUID tag.

maxLength36
created_at: string
match: string
name: string
description: optional string
targeted_tests: optional array of object { data, enabled, name, test_id }
data: object { 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" or "traceroute"

The type of test.

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

The HTTP request method type.

enabled: boolean
name: string
test_id: string
updated_at: optional string
RuleDeleteResponse = boolean
RuleUpdateResponse object { id, created_at, match, 4 more }
id: string

API Resource UUID tag.

maxLength36
created_at: string
match: string
name: string
description: optional string
targeted_tests: optional array of object { data, enabled, name, test_id }
data: object { 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" or "traceroute"

The type of test.

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

The HTTP request method type.

enabled: boolean
name: string
test_id: string
updated_at: optional string
RuleCreateResponse object { id, created_at, match, 4 more }
id: string

API Resource UUID tag.

maxLength36
created_at: string
match: string
name: string
description: optional string
targeted_tests: optional array of object { data, enabled, name, test_id }
data: object { 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" or "traceroute"

The type of test.

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

The HTTP request method type.

enabled: boolean
name: string
test_id: string
updated_at: optional string
RuleListResponse object { rules }
rules: optional array of object { id, created_at, match, 4 more }
id: string

API Resource UUID tag.

maxLength36
created_at: string
match: string
name: string
description: optional string
targeted_tests: optional array of object { data, enabled, name, test_id }
data: object { 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" or "traceroute"

The type of test.

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

The HTTP request method type.

enabled: boolean
name: string
test_id: string
updated_at: optional string