List Device DEX tests

client.ZeroTrust.Devices.DEXTests.List(ctx, params) (*V4PagePaginationArray[DeviceDEXTestListResponse], error)

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

Fetch all DEX tests.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloudflare DEX WriteCloudflare DEX ReadZero Trust ReportZero Trust Read

ParametersExpand Collapse

params DeviceDEXTestListParams

AccountID param.Field[string]

Path param: Unique identifier linked to an account.

maxLength32

Kind param.Field[DeviceDEXTestListParamsKind]Optional

Query param: Filter by test type.

const DeviceDEXTestListParamsKindHTTP DeviceDEXTestListParamsKind = "http"

const DeviceDEXTestListParamsKindTraceroute DeviceDEXTestListParamsKind = "traceroute"

Page param.Field[float64]Optional

Query param: Page number of paginated results.

minimum1

PerPage param.Field[float64]Optional

Query param: Number of results per page.

maximum50

minimum1

TestName param.Field[string]Optional

Query param: Filter by test name.

ReturnsExpand Collapse

type DeviceDEXTestListResponse struct{…}

Data DeviceDEXTestListResponseData

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

Host string

The desired endpoint to test.

Kind DeviceDEXTestListResponseDataKind

The type of test.

One of the following:

const DeviceDEXTestListResponseDataKindHTTP DeviceDEXTestListResponseDataKind = "http"

const DeviceDEXTestListResponseDataKindTraceroute DeviceDEXTestListResponseDataKind = "traceroute"

Method DeviceDEXTestListResponseDataMethodOptional

The HTTP request method type.

Enabled bool

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 stringOptional

Additional details about the test.

TargetPolicies []DeviceDEXTestListResponseTargetPolicyOptional

DEX rules targeted by this test

ID string

The id of the DEX rule.

maxLength36

Default boolOptional

Whether the DEX rule is the account default.

Name stringOptional

The name of the DEX rule.

Targeted boolOptional

TestID stringOptional

The unique identifier for the test.

maxLength32

List Device DEX tests

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/zero_trust"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.ZeroTrust.Devices.DEXTests.List(context.TODO(), zero_trust.DeviceDEXTestListParams{
    AccountID: cloudflare.F("01a7362d577a6c3019a474fd6f485823"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "data": {
        "host": "https://dash.cloudflare.com",
        "kind": "http",
        "method": "GET"
      },
      "enabled": true,
      "interval": "30m",
      "name": "HTTP dash health check",
      "description": "Checks the dash endpoint every 30 minutes",
      "target_policies": [
        {
          "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
          "default": true,
          "name": "name"
        }
      ],
      "targeted": true,
      "test_id": "372e67954025e0ba6aaa6d586b9e0b59"
    }
  ]
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "data": {
        "host": "https://dash.cloudflare.com",
        "kind": "http",
        "method": "GET"
      },
      "enabled": true,
      "interval": "30m",
      "name": "HTTP dash health check",
      "description": "Checks the dash endpoint every 30 minutes",
      "target_policies": [
        {
          "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
          "default": true,
          "name": "name"
        }
      ],
      "targeted": true,
      "test_id": "372e67954025e0ba6aaa6d586b9e0b59"
    }
  ]
}