Skip to content
Cloudflare API
Start here
API Reference
Zero Trust

DEX

ModelsExpand Collapse
class DigitalExperienceMonitor: …
id: str

API Resource UUID tag.

maxLength36
default: bool

Whether the policy is the default for the account

name: str
class NetworkPath: …
slots: List[Slot]
id: str

API Resource UUID tag.

maxLength36
client_to_app_rtt_ms: Optional[int]

Round trip time in ms of the client to app mile

client_to_cf_egress_rtt_ms: Optional[int]

Round trip time in ms of the client to Cloudflare egress mile

client_to_cf_ingress_rtt_ms: Optional[int]

Round trip time in ms of the client to Cloudflare ingress mile

timestamp: str
client_to_isp_rtt_ms: Optional[int]

Round trip time in ms of the client to ISP mile

sampling: Optional[Sampling]

Specifies the sampling applied, if any, to the slots response. When sampled, results shown represent the first test run to the start of each sampling interval.

unit: Literal["hours"]
value: int
class NetworkPathResponse: …
id: str

API Resource UUID tag.

maxLength36
device_name: Optional[str]
interval: Optional[str]

The interval at which the Traceroute synthetic application test is set to run.

kind: Optional[Literal["traceroute"]]
name: Optional[str]
network_path: Optional[NetworkPath]
url: Optional[str]

The host of the Traceroute synthetic application test

class Percentiles: …
p50: Optional[float]

p50 observed in the time period

p90: Optional[float]

p90 observed in the time period

p95: Optional[float]

p95 observed in the time period

p99: Optional[float]

p99 observed in the time period

DEXWARP Change Events

List WARP change events.
zero_trust.dex.warp_change_events.get(WARPChangeEventGetParams**kwargs) -> WARPChangeEventGetResponse
GET/accounts/{account_id}/dex/warp-change-events
ModelsExpand Collapse
List[WARPChangeEventGetResponseItem]
One of the following:
class WARPChangeEventGetResponseItemDigitalExperienceMonitoringWARPToggleChangeEvent: …
account_name: Optional[str]

The account name.

account_tag: Optional[str]

The public account identifier.

device_id: Optional[str]

API Resource UUID tag.

maxLength36
device_registration: Optional[str]

API Resource UUID tag.

maxLength36
hostname: Optional[str]

The hostname of the machine the event is from

serial_number: Optional[str]

The serial number of the machine the event is from

timestamp: Optional[str]

Timestamp in ISO format

toggle: Optional[Literal["on", "off"]]

The state of the WARP toggle.

One of the following:
"on"
"off"
user_email: Optional[str]

Email tied to the device

class WARPChangeEventGetResponseItemDigitalExperienceMonitoringWARPConfigChangeEvent: …
device_id: Optional[str]

API Resource UUID tag.

maxLength36
device_registration: Optional[str]

API Resource UUID tag.

maxLength36
from_: Optional[WARPChangeEventGetResponseItemDigitalExperienceMonitoringWARPConfigChangeEventFrom]
account_name: Optional[str]

The account name.

account_tag: Optional[str]

API Resource UUID tag.

maxLength36
config_name: Optional[str]

The name of the WARP configuration.

hostname: Optional[str]

The hostname of the machine the event is from

serial_number: Optional[str]

The serial number of the machine the event is from

timestamp: Optional[str]

Timestamp in ISO format

to: Optional[WARPChangeEventGetResponseItemDigitalExperienceMonitoringWARPConfigChangeEventTo]
account_name: Optional[str]

The account name.

account_tag: Optional[str]

API Resource UUID tag.

maxLength36
config_name: Optional[str]

The name of the WARP configuration.

user_email: Optional[str]

Email tied to the device

DEXCommands

List account commands
zero_trust.dex.commands.list(CommandListParams**kwargs) -> SyncV4PagePagination[Optional[CommandListResponse]]
GET/accounts/{account_id}/dex/commands
Create account commands
zero_trust.dex.commands.create(CommandCreateParams**kwargs) -> CommandCreateResponse
POST/accounts/{account_id}/dex/commands
ModelsExpand Collapse
class CommandListResponse: …
commands: Optional[List[Command]]
id: Optional[str]
completed_date: Optional[datetime]
formatdate-time
created_date: Optional[datetime]
formatdate-time
device_id: Optional[str]
filename: Optional[str]
registration_id: Optional[str]

Unique identifier for the device registration

status: Optional[str]
type: Optional[str]
user_email: Optional[str]
class CommandCreateResponse: …
commands: Optional[List[Command]]

List of created commands

id: Optional[str]

Unique identifier for the command

args: Optional[Dict[str, str]]

Command arguments

device_id: Optional[str]

Identifier for the device associated with the command

registration_id: Optional[str]

Unique identifier for the device registration

status: Optional[Literal["PENDING_EXEC", "PENDING_UPLOAD", "SUCCESS", "FAILED"]]

Current status of the command

One of the following:
"PENDING_EXEC"
"PENDING_UPLOAD"
"SUCCESS"
"FAILED"
type: Optional[str]

Type of the command (e.g., "pcap" or "warp-diag")

DEXCommandsDevices

List devices eligible for remote captures
zero_trust.dex.commands.devices.list(DeviceListParams**kwargs) -> SyncV4PagePagination[Optional[DeviceListResponse]]
GET/accounts/{account_id}/dex/commands/devices
ModelsExpand Collapse
class DeviceListResponse: …
devices: Optional[List[Device]]

List of eligible devices

device_id: Optional[str]

Device identifier (UUID v4)

device_name: Optional[str]

Device identifier (human readable)

eligible: Optional[bool]

Whether the device is eligible for remote captures

ineligible_reason: Optional[str]

If the device is not eligible, the reason why.

person_email: Optional[str]

User contact email address

platform: Optional[str]

Operating system

registration_id: Optional[str]

Device registration identifier (UUID v4). On multi-user devices, this uniquely identifies a user's registration on the device.

status: Optional[str]

Network status

timestamp: Optional[str]

Timestamp in ISO format

version: Optional[str]

WARP client version

DEXCommandsDownloads

Download command output file
zero_trust.dex.commands.downloads.get(strfilename, DownloadGetParams**kwargs) -> BinaryResponseContent
GET/accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}

DEXCommandsQuota

Returns account commands usage, quota, and reset time
zero_trust.dex.commands.quota.get(QuotaGetParams**kwargs) -> QuotaGetResponse
GET/accounts/{account_id}/dex/commands/quota
ModelsExpand Collapse
class QuotaGetResponse: …
quota: float

The remaining number of commands that can be initiated for an account

quota_usage: float

The number of commands that have been initiated for an account

reset_time: datetime

The time when the quota resets

formatdate-time

DEXColos

List Cloudflare colos
zero_trust.dex.colos.list(ColoListParams**kwargs) -> SyncSinglePage[ColoListResponse]
GET/accounts/{account_id}/dex/colos
ModelsExpand Collapse
class ColoListResponse: …
airport_code: str

Airport code

city: str

City

country_code: str

Country code

DEXFleet Status

List fleet status details by dimension
zero_trust.dex.fleet_status.live(FleetStatusLiveParams**kwargs) -> FleetStatusLiveResponse
GET/accounts/{account_id}/dex/fleet-status/live
List fleet status aggregate details by dimension
zero_trust.dex.fleet_status.over_time(FleetStatusOverTimeParams**kwargs) -> FleetStatusOverTimeResponse
GET/accounts/{account_id}/dex/fleet-status/over-time
ModelsExpand Collapse
class LiveStat: …
unique_devices_total: Optional[float]

Number of unique devices

value: Optional[str]
class FleetStatusLiveResponse: …
device_stats: Optional[DeviceStats]
by_colo: Optional[List[LiveStat]]
unique_devices_total: Optional[float]

Number of unique devices

value: Optional[str]
by_mode: Optional[List[LiveStat]]
unique_devices_total: Optional[float]

Number of unique devices

value: Optional[str]
by_platform: Optional[List[LiveStat]]
unique_devices_total: Optional[float]

Number of unique devices

value: Optional[str]
by_status: Optional[List[LiveStat]]
unique_devices_total: Optional[float]

Number of unique devices

value: Optional[str]
by_version: Optional[List[LiveStat]]
unique_devices_total: Optional[float]

Number of unique devices

value: Optional[str]
unique_devices_total: Optional[float]

Number of unique devices

class FleetStatusOverTimeResponse: …
device_stats: Optional[DeviceStats]
by_mode: Optional[List[DeviceStatsByMode]]
timestamp: Optional[str]

Timestamp in ISO format

unique_devices_total: Optional[float]

Number of unique devices

value: Optional[str]
by_status: Optional[List[DeviceStatsByStatus]]
timestamp: Optional[str]

Timestamp in ISO format

unique_devices_total: Optional[float]

Number of unique devices

value: Optional[str]
unique_devices_total: Optional[float]

Number of unique devices

DEXFleet StatusDevices

List fleet status devices
zero_trust.dex.fleet_status.devices.list(DeviceListParams**kwargs) -> SyncV4PagePaginationArray[DeviceListResponse]
GET/accounts/{account_id}/dex/fleet-status/devices
ModelsExpand Collapse
class DeviceListResponse: …
colo: str

Cloudflare colo

device_id: str

Device identifier (UUID v4)

mode: str

The mode under which the WARP client is run

platform: str

Operating system

status: str

Network status

timestamp: str

Timestamp in ISO format

version: str

WARP client version

always_on: Optional[bool]
battery_charging: Optional[bool]
battery_cycles: Optional[int]
formatint64
battery_pct: Optional[float]
formatfloat
connection_type: Optional[str]
cpu_pct: Optional[float]
formatfloat
cpu_pct_by_app: Optional[List[List[CPUPctByApp]]]
cpu_pct: Optional[float]
formatfloat
name: Optional[str]
device_ipv4: Optional[DeviceIPV4]
address: Optional[str]
asn: Optional[int]
aso: Optional[str]
location: Optional[DeviceIPV4Location]
city: Optional[str]
country_iso: Optional[str]
state_iso: Optional[str]
zip: Optional[str]
netmask: Optional[str]
version: Optional[str]
device_ipv6: Optional[DeviceIPV6]
address: Optional[str]
asn: Optional[int]
aso: Optional[str]
location: Optional[DeviceIPV6Location]
city: Optional[str]
country_iso: Optional[str]
state_iso: Optional[str]
zip: Optional[str]
netmask: Optional[str]
version: Optional[str]
device_name: Optional[str]

Device identifier (human readable)

disk_read_bps: Optional[int]
formatint64
disk_usage_pct: Optional[float]
formatfloat
disk_write_bps: Optional[int]
formatint64
doh_subdomain: Optional[str]
estimated_loss_pct: Optional[float]
formatfloat
firewall_enabled: Optional[bool]
gateway_ipv4: Optional[GatewayIPV4]
address: Optional[str]
asn: Optional[int]
aso: Optional[str]
location: Optional[GatewayIPV4Location]
city: Optional[str]
country_iso: Optional[str]
state_iso: Optional[str]
zip: Optional[str]
netmask: Optional[str]
version: Optional[str]
gateway_ipv6: Optional[GatewayIPV6]
address: Optional[str]
asn: Optional[int]
aso: Optional[str]
location: Optional[GatewayIPV6Location]
city: Optional[str]
country_iso: Optional[str]
state_iso: Optional[str]
zip: Optional[str]
netmask: Optional[str]
version: Optional[str]
handshake_latency_ms: Optional[float]
formatint64
isp_ipv4: Optional[ISPIPV4]
address: Optional[str]
asn: Optional[int]
aso: Optional[str]
location: Optional[ISPIPV4Location]
city: Optional[str]
country_iso: Optional[str]
state_iso: Optional[str]
zip: Optional[str]
netmask: Optional[str]
version: Optional[str]
isp_ipv6: Optional[ISPIPV6]
address: Optional[str]
asn: Optional[int]
aso: Optional[str]
location: Optional[ISPIPV6Location]
city: Optional[str]
country_iso: Optional[str]
state_iso: Optional[str]
zip: Optional[str]
netmask: Optional[str]
version: Optional[str]
metal: Optional[str]
network_rcvd_bps: Optional[int]
formatint64
network_sent_bps: Optional[int]
formatint64
network_ssid: Optional[str]
person_email: Optional[str]

User contact email address

ram_available_kb: Optional[int]
formatint64
ram_used_pct: Optional[float]
formatfloat
ram_used_pct_by_app: Optional[List[List[RamUsedPctByApp]]]
name: Optional[str]
ram_used_pct: Optional[float]
formatfloat
switch_locked: Optional[bool]
wifi_strength_dbm: Optional[int]
formatint64

DEXHTTP Tests

Get details and aggregate metrics for an http test
zero_trust.dex.http_tests.get(strtest_id, HTTPTestGetParams**kwargs) -> HTTPDetails
GET/accounts/{account_id}/dex/http-tests/{test_id}
ModelsExpand Collapse
class HTTPDetails: …
host: Optional[str]

The url of the HTTP synthetic application test

http_stats: Optional[HTTPStats]
availability_pct: HTTPStatsAvailabilityPct
slots: List[HTTPStatsAvailabilityPctSlot]
timestamp: str
value: float
formatfloat
avg: Optional[float]

average observed in the time period

formatfloat
max: Optional[float]

highest observed in the time period

formatfloat
min: Optional[float]

lowest observed in the time period

formatfloat
dns_response_time_ms: TestStatOverTime
http_status_code: List[HTTPStatsHTTPStatusCode]
status200: int
status300: int
status400: int
status500: int
timestamp: str
resource_fetch_time_ms: TestStatOverTime
server_response_time_ms: TestStatOverTime
unique_devices_total: int

Count of unique devices that have run this test in the given time period

http_stats_by_colo: Optional[List[HTTPStatsByColo]]
availability_pct: HTTPStatsByColoAvailabilityPct
slots: List[HTTPStatsByColoAvailabilityPctSlot]
timestamp: str
value: float
formatfloat
avg: Optional[float]

average observed in the time period

formatfloat
max: Optional[float]

highest observed in the time period

formatfloat
min: Optional[float]

lowest observed in the time period

formatfloat
colo: str
dns_response_time_ms: TestStatOverTime
http_status_code: List[HTTPStatsByColoHTTPStatusCode]
status200: int
status300: int
status400: int
status500: int
timestamp: str
resource_fetch_time_ms: TestStatOverTime
server_response_time_ms: TestStatOverTime
unique_devices_total: int

Count of unique devices that have run this test in the given time period

interval: Optional[str]

The interval at which the HTTP synthetic application test is set to run.

kind: Optional[Literal["http"]]
method: Optional[str]

The HTTP method to use when running the test

name: Optional[str]

The name of the HTTP synthetic application test

target_policies: Optional[List[DigitalExperienceMonitor]]
id: str

API Resource UUID tag.

maxLength36
default: bool

Whether the policy is the default for the account

name: str
targeted: Optional[bool]

DEXHTTP TestsPercentiles

Get percentiles for an http test
zero_trust.dex.http_tests.percentiles.get(strtest_id, PercentileGetParams**kwargs) -> HTTPDetailsPercentiles
GET/accounts/{account_id}/dex/http-tests/{test_id}/percentiles
ModelsExpand Collapse
class HTTPDetailsPercentiles: …
dns_response_time_ms: Optional[Percentiles]
resource_fetch_time_ms: Optional[Percentiles]
server_response_time_ms: Optional[Percentiles]
class TestStatOverTime: …
slots: List[Slot]
timestamp: str
value: int
avg: Optional[int]

average observed in the time period

max: Optional[int]

highest observed in the time period

min: Optional[int]

lowest observed in the time period

DEXTests

List DEX test analytics
zero_trust.dex.tests.list(TestListParams**kwargs) -> SyncV4PagePagination[Optional[Tests]]
GET/accounts/{account_id}/dex/tests/overview
ModelsExpand Collapse
class AggregateTimePeriod: …
units: Literal["hours", "days", "testRuns"]
One of the following:
"hours"
"days"
"testRuns"
value: int
class Tests: …
overview_metrics: OverviewMetrics
tests_total: int

number of tests.

avg_http_availability_pct: Optional[float]

percentage availability for all HTTP test results in response

formatfloat
avg_traceroute_availability_pct: Optional[float]

percentage availability for all traceroutes results in response

formatfloat
tests: List[Test]

array of test results objects.

id: str

API Resource UUID tag.

maxLength36
created: str

date the test was created.

description: str

the test description defined during configuration

enabled: bool

if true, then the test will run on targeted devices. Else, the test will not run.

host: str
interval: str

The interval at which the synthetic application test is set to run.

kind: Literal["http", "traceroute"]

test type, http or traceroute

One of the following:
"http"
"traceroute"
name: str

name given to this test

updated: str
http_results: Optional[TestHTTPResults]
resource_fetch_time: TestHTTPResultsResourceFetchTime
history: List[TestHTTPResultsResourceFetchTimeHistory]
time_period: AggregateTimePeriod
avg_ms: Optional[int]
delta_pct: Optional[float]
formatfloat
avg_ms: Optional[int]
over_time: Optional[TestHTTPResultsResourceFetchTimeOverTime]
time_period: AggregateTimePeriod
values: List[TestHTTPResultsResourceFetchTimeOverTimeValue]
avg_ms: int
timestamp: str
http_results_by_colo: Optional[List[TestHTTPResultsByColo]]
colo: str

Cloudflare colo

resource_fetch_time: TestHTTPResultsByColoResourceFetchTime
history: List[TestHTTPResultsByColoResourceFetchTimeHistory]
time_period: AggregateTimePeriod
avg_ms: Optional[int]
delta_pct: Optional[float]
formatfloat
avg_ms: Optional[int]
over_time: Optional[TestHTTPResultsByColoResourceFetchTimeOverTime]
time_period: AggregateTimePeriod
values: List[TestHTTPResultsByColoResourceFetchTimeOverTimeValue]
avg_ms: int
timestamp: str
method: Optional[str]

for HTTP, the method to use when running the test

target_policies: Optional[List[DigitalExperienceMonitor]]
id: str

API Resource UUID tag.

maxLength36
default: bool

Whether the policy is the default for the account

name: str
targeted: Optional[bool]
traceroute_results: Optional[TestTracerouteResults]
round_trip_time: TestTracerouteResultsRoundTripTime
history: List[TestTracerouteResultsRoundTripTimeHistory]
time_period: AggregateTimePeriod
avg_ms: Optional[int]
delta_pct: Optional[float]
formatfloat
avg_ms: Optional[int]
over_time: Optional[TestTracerouteResultsRoundTripTimeOverTime]
time_period: AggregateTimePeriod
values: List[TestTracerouteResultsRoundTripTimeOverTimeValue]
avg_ms: int
timestamp: str
traceroute_results_by_colo: Optional[List[TestTracerouteResultsByColo]]
colo: str

Cloudflare colo

round_trip_time: TestTracerouteResultsByColoRoundTripTime
history: List[TestTracerouteResultsByColoRoundTripTimeHistory]
time_period: AggregateTimePeriod
avg_ms: Optional[int]
delta_pct: Optional[float]
formatfloat
avg_ms: Optional[int]
over_time: Optional[TestTracerouteResultsByColoRoundTripTimeOverTime]
time_period: AggregateTimePeriod
values: List[TestTracerouteResultsByColoRoundTripTimeOverTimeValue]
avg_ms: int
timestamp: str

DEXTestsUnique Devices

Get count of devices targeted
zero_trust.dex.tests.unique_devices.list(UniqueDeviceListParams**kwargs) -> UniqueDevices
GET/accounts/{account_id}/dex/tests/unique-devices
ModelsExpand Collapse
class UniqueDevices: …
unique_devices_total: int

total number of unique devices

DEXTraceroute Test Results

DEXTraceroute Test ResultsNetwork Path

Get details for a specific traceroute test run
zero_trust.dex.traceroute_test_results.network_path.get(strtest_result_id, NetworkPathGetParams**kwargs) -> NetworkPathGetResponse
GET/accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path
ModelsExpand Collapse
class NetworkPathGetResponse: …
hops: List[Hop]

an array of the hops taken by the device to reach the end destination

ttl: int
asn: Optional[int]
aso: Optional[str]
ip_address: Optional[str]
location: Optional[HopLocation]
city: Optional[str]
state: Optional[str]
zip: Optional[str]
mile: Optional[Literal["client-to-app", "client-to-cf-egress", "client-to-cf-ingress", "client-to-isp"]]
One of the following:
"client-to-app"
"client-to-cf-egress"
"client-to-cf-ingress"
"client-to-isp"
name: Optional[str]
packet_loss_pct: Optional[float]
formatfloat
rtt_ms: Optional[int]
result_id: str

API Resource UUID tag.

maxLength36
device_name: Optional[str]

name of the device associated with this network path response

test_id: Optional[str]

API Resource UUID tag.

maxLength36
test_name: Optional[str]

name of the tracroute test

DEXTraceroute Tests

Get details and aggregate metrics for a traceroute test
zero_trust.dex.traceroute_tests.get(strtest_id, TracerouteTestGetParams**kwargs) -> Traceroute
GET/accounts/{account_id}/dex/traceroute-tests/{test_id}
Get percentiles for a traceroute test
zero_trust.dex.traceroute_tests.percentiles(strtest_id, TracerouteTestPercentilesParams**kwargs) -> TracerouteTestPercentilesResponse
GET/accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles
Get network path breakdown for a traceroute test
zero_trust.dex.traceroute_tests.network_path(strtest_id, TracerouteTestNetworkPathParams**kwargs) -> NetworkPathResponse
GET/accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path
ModelsExpand Collapse
class Traceroute: …
host: str

The host of the Traceroute synthetic application test

interval: str

The interval at which the Traceroute synthetic application test is set to run.

kind: Literal["traceroute"]
name: str

The name of the Traceroute synthetic application test

target_policies: Optional[List[DigitalExperienceMonitor]]
id: str

API Resource UUID tag.

maxLength36
default: bool

Whether the policy is the default for the account

name: str
targeted: Optional[bool]
traceroute_stats: Optional[TracerouteStats]
availability_pct: TracerouteStatsAvailabilityPct
slots: List[TracerouteStatsAvailabilityPctSlot]
timestamp: str
value: float
formatfloat
avg: Optional[float]

average observed in the time period

formatfloat
max: Optional[float]

highest observed in the time period

formatfloat
min: Optional[float]

lowest observed in the time period

formatfloat
hops_count: TestStatOverTime
packet_loss_pct: TracerouteStatsPacketLossPct
slots: List[TracerouteStatsPacketLossPctSlot]
timestamp: str
value: float
formatfloat
avg: Optional[float]

average observed in the time period

formatfloat
max: Optional[float]

highest observed in the time period

formatfloat
min: Optional[float]

lowest observed in the time period

formatfloat
round_trip_time_ms: TestStatOverTime
unique_devices_total: int

Count of unique devices that have run this test in the given time period

traceroute_stats_by_colo: Optional[List[TracerouteStatsByColo]]
availability_pct: TracerouteStatsByColoAvailabilityPct
slots: List[TracerouteStatsByColoAvailabilityPctSlot]
timestamp: str
value: float
formatfloat
avg: Optional[float]

average observed in the time period

formatfloat
max: Optional[float]

highest observed in the time period

formatfloat
min: Optional[float]

lowest observed in the time period

formatfloat
colo: str
hops_count: TestStatOverTime
packet_loss_pct: TracerouteStatsByColoPacketLossPct
slots: List[TracerouteStatsByColoPacketLossPctSlot]
timestamp: str
value: float
formatfloat
avg: Optional[float]

average observed in the time period

formatfloat
max: Optional[float]

highest observed in the time period

formatfloat
min: Optional[float]

lowest observed in the time period

formatfloat
round_trip_time_ms: TestStatOverTime
unique_devices_total: int

Count of unique devices that have run this test in the given time period

class TracerouteTestPercentilesResponse: …
hops_count: Optional[Percentiles]
packet_loss_pct: Optional[Percentiles]
round_trip_time_ms: Optional[Percentiles]

DEXRules

Get DEX Rule
zero_trust.dex.rules.get(strrule_id, RuleGetParams**kwargs) -> RuleGetResponse
GET/accounts/{account_id}/dex/rules/{rule_id}
Delete a DEX Rule
zero_trust.dex.rules.delete(strrule_id, RuleDeleteParams**kwargs) -> RuleDeleteResponse
DELETE/accounts/{account_id}/dex/rules/{rule_id}
Update a DEX Rule
zero_trust.dex.rules.update(strrule_id, RuleUpdateParams**kwargs) -> RuleUpdateResponse
PATCH/accounts/{account_id}/dex/rules/{rule_id}
Create a DEX Rule
zero_trust.dex.rules.create(RuleCreateParams**kwargs) -> RuleCreateResponse
POST/accounts/{account_id}/dex/rules
List DEX Rules
zero_trust.dex.rules.list(RuleListParams**kwargs) -> SyncV4PagePagination[Optional[RuleListResponse]]
GET/accounts/{account_id}/dex/rules
ModelsExpand Collapse
class RuleGetResponse: …
id: str

API Resource UUID tag.

maxLength36
created_at: str
match: str
name: str
description: Optional[str]
targeted_tests: Optional[List[TargetedTest]]
data: TargetedTestData

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

host: str

The desired endpoint to test.

kind: Literal["http", "traceroute"]

The type of test.

One of the following:
"http"
"traceroute"
method: Optional[Literal["GET"]]

The HTTP request method type.

enabled: bool
name: str
test_id: str
updated_at: Optional[str]
Optional[bool]
class RuleUpdateResponse: …
id: str

API Resource UUID tag.

maxLength36
created_at: str
match: str
name: str
description: Optional[str]
targeted_tests: Optional[List[TargetedTest]]
data: TargetedTestData

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

host: str

The desired endpoint to test.

kind: Literal["http", "traceroute"]

The type of test.

One of the following:
"http"
"traceroute"
method: Optional[Literal["GET"]]

The HTTP request method type.

enabled: bool
name: str
test_id: str
updated_at: Optional[str]
class RuleCreateResponse: …
id: str

API Resource UUID tag.

maxLength36
created_at: str
match: str
name: str
description: Optional[str]
targeted_tests: Optional[List[TargetedTest]]
data: TargetedTestData

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

host: str

The desired endpoint to test.

kind: Literal["http", "traceroute"]

The type of test.

One of the following:
"http"
"traceroute"
method: Optional[Literal["GET"]]

The HTTP request method type.

enabled: bool
name: str
test_id: str
updated_at: Optional[str]
class RuleListResponse: …
rules: Optional[List[Rule]]
id: str

API Resource UUID tag.

maxLength36
created_at: str
match: str
name: str
description: Optional[str]
targeted_tests: Optional[List[RuleTargetedTest]]
data: RuleTargetedTestData

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

host: str

The desired endpoint to test.

kind: Literal["http", "traceroute"]

The type of test.

One of the following:
"http"
"traceroute"
method: Optional[Literal["GET"]]

The HTTP request method type.

enabled: bool
name: str
test_id: str
updated_at: Optional[str]