List DEX Rules

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

GET/accounts/{account_id}/dex/rules

List DEX Rules.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

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 DEXRuleListParams

AccountID param.Field[string]

Path param: Unique identifier linked to an account.

maxLength32

Page param.Field[float64]

Query param: Page number of paginated results.

minimum1

PerPage param.Field[float64]

Query param: Number of results per page.

maximum50

minimum1

Name param.Field[string]Optional

Query param: Filter results by rule name.

SortBy param.Field[DEXRuleListParamsSortBy]Optional

Query param: Which property to sort results by.

const DEXRuleListParamsSortByName DEXRuleListParamsSortBy = "name"

const DEXRuleListParamsSortByCreatedAt DEXRuleListParamsSortBy = "created_at"

const DEXRuleListParamsSortByUpdatedAt DEXRuleListParamsSortBy = "updated_at"

SortOrder param.Field[DEXRuleListParamsSortOrder]Optional

Query param: Sort direction for sort_by property.

const DEXRuleListParamsSortOrderAsc DEXRuleListParamsSortOrder = "ASC"

const DEXRuleListParamsSortOrderDesc DEXRuleListParamsSortOrder = "DESC"

ReturnsExpand Collapse

type DEXRuleListResponse struct{…}

Rules []DEXRuleListResponseRuleOptional

ID string

API Resource UUID tag.

maxLength36

CreatedAt string

Match string

Name string

Description stringOptional

TargetedTests []DEXRuleListResponseRulesTargetedTestOptional

Data DEXRuleListResponseRulesTargetedTestsData

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

Host string

The desired endpoint to test.

Kind DEXRuleListResponseRulesTargetedTestsDataKind

The type of test.

One of the following:

const DEXRuleListResponseRulesTargetedTestsDataKindHTTP DEXRuleListResponseRulesTargetedTestsDataKind = "http"

const DEXRuleListResponseRulesTargetedTestsDataKindTraceroute DEXRuleListResponseRulesTargetedTestsDataKind = "traceroute"

Method DEXRuleListResponseRulesTargetedTestsDataMethodOptional

The HTTP request method type.

Enabled bool

Name string

TestID string

UpdatedAt stringOptional

List DEX Rules

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.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.ZeroTrust.DEX.Rules.List(context.TODO(), zero_trust.DEXRuleListParams{
    AccountID: cloudflare.F("01a7362d577a6c3019a474fd6f485823"),
    Page: cloudflare.F(1.000000),
    PerPage: cloudflare.F(10.000000),
  })
  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": {
    "rules": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "created_at": "2023-07-16 15:00:00+00",
        "match": "match",
        "name": "name",
        "description": "description",
        "targeted_tests": [
          {
            "data": {
              "host": "https://dash.cloudflare.com",
              "kind": "http",
              "method": "GET"
            },
            "enabled": true,
            "name": "name",
            "test_id": "test_id"
          }
        ],
        "updated_at": "2023-07-16 15:00:00+00"
      }
    ]
  },
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

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": {
    "rules": [
      {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "created_at": "2023-07-16 15:00:00+00",
        "match": "match",
        "name": "name",
        "description": "description",
        "targeted_tests": [
          {
            "data": {
              "host": "https://dash.cloudflare.com",
              "kind": "http",
              "method": "GET"
            },
            "enabled": true,
            "name": "name",
            "test_id": "test_id"
          }
        ],
        "updated_at": "2023-07-16 15:00:00+00"
      }
    ]
  },
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}