DEX

ModelsExpand Collapse

type DigitalExperienceMonitor struct{…}

ID string

API Resource UUID tag.

maxLength36

Default bool

Whether the policy is the default for the account

Name string

type NetworkPath struct{…}

Slots []NetworkPathSlot

ID string

API Resource UUID tag.

maxLength36

ClientToAppRTTMs int64

Round trip time in ms of the client to app mile

ClientToCfEgressRTTMs int64

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

ClientToCfIngressRTTMs int64

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

Timestamp string

ClientToISPRTTMs int64optional

Round trip time in ms of the client to ISP mile

Sampling NetworkPathSamplingoptional

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 NetworkPathSamplingUnit

Value int64

type NetworkPathResponse struct{…}

ID string

API Resource UUID tag.

maxLength36

DeviceName stringoptional

Interval stringoptional

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

Kind NetworkPathResponseKindoptional

Name stringoptional

NetworkPath NetworkPathoptional

URL stringoptional

The host of the Traceroute synthetic application test

type Percentiles struct{…}

P50 float64optional

p50 observed in the time period

P90 float64optional

p90 observed in the time period

P95 float64optional

p95 observed in the time period

P99 float64optional

p99 observed in the time period

DEXWARP Change Events

List WARP change events.

client.ZeroTrust.DEX.WARPChangeEvents.Get(ctx, params) (*[]DexwarpChangeEventGetResponse, error)

GET/accounts/{account_id}/dex/warp-change-events

DEXCommands

List account commands

client.ZeroTrust.DEX.Commands.List(ctx, params) (*V4PagePagination[DEXCommandListResponse], error)

GET/accounts/{account_id}/dex/commands

Create account commands

client.ZeroTrust.DEX.Commands.New(ctx, params) (*DEXCommandNewResponse, error)

POST/accounts/{account_id}/dex/commands

DEXCommandsDevices

List devices eligible for remote captures

client.ZeroTrust.DEX.Commands.Devices.List(ctx, params) (*V4PagePagination[DEXCommandDeviceListResponse], error)

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

DEXCommandsDownloads

Download command output file

client.ZeroTrust.DEX.Commands.Downloads.Get(ctx, commandID, filename, query) (*Response, error)

GET/accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}

DEXCommandsQuota

Returns account commands usage, quota, and reset time

client.ZeroTrust.DEX.Commands.Quota.Get(ctx, query) (*DEXCommandQuotaGetResponse, error)

GET/accounts/{account_id}/dex/commands/quota

DEXColos

List Cloudflare colos

client.ZeroTrust.DEX.Colos.List(ctx, params) (*SinglePage[DEXColoListResponse], error)

GET/accounts/{account_id}/dex/colos

DEXFleet Status

List fleet status details by dimension

client.ZeroTrust.DEX.FleetStatus.Live(ctx, params) (*DEXFleetStatusLiveResponse, error)

GET/accounts/{account_id}/dex/fleet-status/live

List fleet status aggregate details by dimension

client.ZeroTrust.DEX.FleetStatus.OverTime(ctx, params) (*DEXFleetStatusOverTimeResponse, error)

GET/accounts/{account_id}/dex/fleet-status/over-time

ModelsExpand Collapse

type LiveStat struct{…}

UniqueDevicesTotal float64optional

Number of unique devices

Value stringoptional

DEXFleet StatusDevices

List fleet status devices

client.ZeroTrust.DEX.FleetStatus.Devices.List(ctx, params) (*V4PagePaginationArray[DEXFleetStatusDeviceListResponse], error)

GET/accounts/{account_id}/dex/fleet-status/devices

DEXHTTP Tests

Get details and aggregate metrics for an http test

client.ZeroTrust.DEX.HTTPTests.Get(ctx, testID, params) (*HTTPDetails, error)

GET/accounts/{account_id}/dex/http-tests/{test_id}

ModelsExpand Collapse

type HTTPDetails struct{…}

Host stringoptional

The url of the HTTP synthetic application test

HTTPStats HTTPDetailsHTTPStatsoptional

AvailabilityPct HTTPDetailsHTTPStatsAvailabilityPct

Slots []HTTPDetailsHTTPStatsAvailabilityPctSlot

Timestamp string

Value float64

formatfloat

Avg float64optional

average observed in the time period

formatfloat

Max float64optional

highest observed in the time period

formatfloat

Min float64optional

lowest observed in the time period

formatfloat

DNSResponseTimeMs TestStatOverTime

HTTPStatusCode []HTTPDetailsHTTPStatsHTTPStatusCode

Status200 int64

Status300 int64

Status400 int64

Status500 int64

Timestamp string

ResourceFetchTimeMs TestStatOverTime

ServerResponseTimeMs TestStatOverTime

UniqueDevicesTotal int64

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

HTTPStatsByColo []HTTPDetailsHTTPStatsByColooptional

AvailabilityPct HTTPDetailsHTTPStatsByColoAvailabilityPct

Slots []HTTPDetailsHTTPStatsByColoAvailabilityPctSlot

Timestamp string

Value float64

formatfloat

Avg float64optional

average observed in the time period

formatfloat

Max float64optional

highest observed in the time period

formatfloat

Min float64optional

lowest observed in the time period

formatfloat

Colo string

DNSResponseTimeMs TestStatOverTime

HTTPStatusCode []HTTPDetailsHTTPStatsByColoHTTPStatusCode

Status200 int64

Status300 int64

Status400 int64

Status500 int64

Timestamp string

ResourceFetchTimeMs TestStatOverTime

ServerResponseTimeMs TestStatOverTime

UniqueDevicesTotal int64

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

Interval stringoptional

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

Kind HTTPDetailsKindoptional

Method stringoptional

The HTTP method to use when running the test

Name stringoptional

The name of the HTTP synthetic application test

TargetPolicies []DigitalExperienceMonitoroptional

ID string

API Resource UUID tag.

maxLength36

Default bool

Whether the policy is the default for the account

Name string

Targeted booloptional

DEXHTTP TestsPercentiles

Get percentiles for an http test

client.ZeroTrust.DEX.HTTPTests.Percentiles.Get(ctx, testID, params) (*HTTPDetailsPercentiles, error)

GET/accounts/{account_id}/dex/http-tests/{test_id}/percentiles

ModelsExpand Collapse

type HTTPDetailsPercentiles struct{…}

DNSResponseTimeMs Percentilesoptional

ResourceFetchTimeMs Percentilesoptional

ServerResponseTimeMs Percentilesoptional

type TestStatOverTime struct{…}

Slots []TestStatOverTimeSlot

Timestamp string

Value int64

Avg int64optional

average observed in the time period

Max int64optional

highest observed in the time period

Min int64optional

lowest observed in the time period

DEXTests

List DEX test analytics

client.ZeroTrust.DEX.Tests.List(ctx, params) (*V4PagePagination[Tests], error)

GET/accounts/{account_id}/dex/tests/overview

ModelsExpand Collapse

type AggregateTimePeriod struct{…}

Units AggregateTimePeriodUnits

One of the following:

const AggregateTimePeriodUnitsHours AggregateTimePeriodUnits = "hours"

const AggregateTimePeriodUnitsDays AggregateTimePeriodUnits = "days"

const AggregateTimePeriodUnitsTestRuns AggregateTimePeriodUnits = "testRuns"

Value int64

type Tests struct{…}

OverviewMetrics TestsOverviewMetrics

TestsTotal int64

number of tests.

AvgHTTPAvailabilityPct float64optional

percentage availability for all HTTP test results in response

formatfloat

AvgTracerouteAvailabilityPct float64optional

percentage availability for all traceroutes results in response

formatfloat

Tests []TestsTest

array of test results objects.

ID string

API Resource UUID tag.

maxLength36

Created string

date the test was created.

Description string

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 string

Interval string

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

Kind TestsTestsKind

test type, http or traceroute

One of the following:

const TestsTestsKindHTTP TestsTestsKind = "http"

const TestsTestsKindTraceroute TestsTestsKind = "traceroute"

Name string

name given to this test

Updated string

HTTPResults TestsTestsHTTPResultsoptional

ResourceFetchTime TestsTestsHTTPResultsResourceFetchTime

History []TestsTestsHTTPResultsResourceFetchTimeHistory

TimePeriod AggregateTimePeriod

AvgMs int64optional

DeltaPct float64optional

formatfloat

AvgMs int64optional

OverTime TestsTestsHTTPResultsResourceFetchTimeOverTimeoptional

TimePeriod AggregateTimePeriod

Values []TestsTestsHTTPResultsResourceFetchTimeOverTimeValue

AvgMs int64

Timestamp string

HTTPResultsByColo []TestsTestsHTTPResultsByColooptional

Colo string

Cloudflare colo

ResourceFetchTime TestsTestsHTTPResultsByColoResourceFetchTime

History []TestsTestsHTTPResultsByColoResourceFetchTimeHistory

TimePeriod AggregateTimePeriod

AvgMs int64optional

DeltaPct float64optional

formatfloat

AvgMs int64optional

OverTime TestsTestsHTTPResultsByColoResourceFetchTimeOverTimeoptional

TimePeriod AggregateTimePeriod

Values []TestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValue

AvgMs int64

Timestamp string

Method stringoptional

for HTTP, the method to use when running the test

TargetPolicies []DigitalExperienceMonitoroptional

ID string

API Resource UUID tag.

maxLength36

Default bool

Whether the policy is the default for the account

Name string

Targeted booloptional

TracerouteResults TestsTestsTracerouteResultsoptional

RoundTripTime TestsTestsTracerouteResultsRoundTripTime

History []TestsTestsTracerouteResultsRoundTripTimeHistory

TimePeriod AggregateTimePeriod

AvgMs int64optional

DeltaPct float64optional

formatfloat

AvgMs int64optional

OverTime TestsTestsTracerouteResultsRoundTripTimeOverTimeoptional

TimePeriod AggregateTimePeriod

Values []TestsTestsTracerouteResultsRoundTripTimeOverTimeValue

AvgMs int64

Timestamp string

TracerouteResultsByColo []TestsTestsTracerouteResultsByColooptional

Colo string

Cloudflare colo

RoundTripTime TestsTestsTracerouteResultsByColoRoundTripTime

History []TestsTestsTracerouteResultsByColoRoundTripTimeHistory

TimePeriod AggregateTimePeriod

AvgMs int64optional

DeltaPct float64optional

formatfloat

AvgMs int64optional

OverTime TestsTestsTracerouteResultsByColoRoundTripTimeOverTimeoptional

TimePeriod AggregateTimePeriod

Values []TestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValue

AvgMs int64

Timestamp string

DEXTestsUnique Devices

Get count of devices targeted

client.ZeroTrust.DEX.Tests.UniqueDevices.List(ctx, params) (*UniqueDevices, error)

GET/accounts/{account_id}/dex/tests/unique-devices

ModelsExpand Collapse

type UniqueDevices struct{…}

UniqueDevicesTotal int64

total number of unique devices

DEXTraceroute Test Results

DEXTraceroute Test ResultsNetwork Path

Get details for a specific traceroute test run

client.ZeroTrust.DEX.TracerouteTestResults.NetworkPath.Get(ctx, testResultID, query) (*DEXTracerouteTestResultNetworkPathGetResponse, error)

GET/accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path

DEXTraceroute Tests

Get details and aggregate metrics for a traceroute test

client.ZeroTrust.DEX.TracerouteTests.Get(ctx, testID, params) (*Traceroute, error)

GET/accounts/{account_id}/dex/traceroute-tests/{test_id}

Get percentiles for a traceroute test

client.ZeroTrust.DEX.TracerouteTests.Percentiles(ctx, testID, params) (*DEXTracerouteTestPercentilesResponse, error)

GET/accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles

Get network path breakdown for a traceroute test

client.ZeroTrust.DEX.TracerouteTests.NetworkPath(ctx, testID, params) (*NetworkPathResponse, error)

GET/accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path

ModelsExpand Collapse

type Traceroute struct{…}

Host string

The host of the Traceroute synthetic application test

Interval string

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

Kind TracerouteKind

Name string

The name of the Traceroute synthetic application test

TargetPolicies []DigitalExperienceMonitoroptional

ID string

API Resource UUID tag.

maxLength36

Default bool

Whether the policy is the default for the account

Name string

Targeted booloptional

TracerouteStats TracerouteTracerouteStatsoptional

AvailabilityPct TracerouteTracerouteStatsAvailabilityPct

Slots []TracerouteTracerouteStatsAvailabilityPctSlot

Timestamp string

Value float64

formatfloat

Avg float64optional

average observed in the time period

formatfloat

Max float64optional

highest observed in the time period

formatfloat

Min float64optional

lowest observed in the time period

formatfloat

HopsCount TestStatOverTime

PacketLossPct TracerouteTracerouteStatsPacketLossPct

Slots []TracerouteTracerouteStatsPacketLossPctSlot

Timestamp string

Value float64

formatfloat

Avg float64optional

average observed in the time period

formatfloat

Max float64optional

highest observed in the time period

formatfloat

Min float64optional

lowest observed in the time period

formatfloat

RoundTripTimeMs TestStatOverTime

UniqueDevicesTotal int64

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

TracerouteStatsByColo []TracerouteTracerouteStatsByColooptional

AvailabilityPct TracerouteTracerouteStatsByColoAvailabilityPct

Slots []TracerouteTracerouteStatsByColoAvailabilityPctSlot

Timestamp string

Value float64

formatfloat

Avg float64optional

average observed in the time period

formatfloat

Max float64optional

highest observed in the time period

formatfloat

Min float64optional

lowest observed in the time period

formatfloat

Colo string

HopsCount TestStatOverTime

PacketLossPct TracerouteTracerouteStatsByColoPacketLossPct

Slots []TracerouteTracerouteStatsByColoPacketLossPctSlot

Timestamp string

Value float64

formatfloat

Avg float64optional

average observed in the time period

formatfloat

Max float64optional

highest observed in the time period

formatfloat

Min float64optional

lowest observed in the time period

formatfloat

RoundTripTimeMs TestStatOverTime

UniqueDevicesTotal int64

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

DEXRules

Get DEX Rule

client.ZeroTrust.DEX.Rules.Get(ctx, ruleID, query) (*DEXRuleGetResponse, error)

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

Delete a DEX Rule

client.ZeroTrust.DEX.Rules.Delete(ctx, ruleID, body) (*bool, error)

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

Update a DEX Rule

client.ZeroTrust.DEX.Rules.Update(ctx, ruleID, params) (*DEXRuleUpdateResponse, error)

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

Create a DEX Rule

client.ZeroTrust.DEX.Rules.New(ctx, params) (*DEXRuleNewResponse, error)

POST/accounts/{account_id}/dex/rules

List DEX Rules

client.ZeroTrust.DEX.Rules.List(ctx, params) (*V4PagePagination[DEXRuleListResponse], error)

GET/accounts/{account_id}/dex/rules