Rules

client.CloudConnector.Rules.List(ctx, query) (*SinglePage[RuleListResponse], error)

GET/zones/{zone_id}/cloud_connector/rules

Rules

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)

Cloud Connector ReadCloud Connector Write

ParametersExpand Collapse

query RuleListParams

ZoneID param.Field[string]

Identifier.

maxLength32

ReturnsExpand Collapse

type RuleListResponse struct{…}

ID stringoptional

Description stringoptional

Enabled booloptional

Expression stringoptional

Parameters RuleListResponseParametersoptional

Parameters of Cloud Connector Rule

Host stringoptional

Host to perform Cloud Connection to

Provider RuleListResponseProvideroptional

Cloud Provider type

One of the following:

const RuleListResponseProviderAwsS3 RuleListResponseProvider = "aws_s3"

const RuleListResponseProviderCloudflareR2 RuleListResponseProvider = "cloudflare_r2"

const RuleListResponseProviderGcpStorage RuleListResponseProvider = "gcp_storage"

const RuleListResponseProviderAzureStorage RuleListResponseProvider = "azure_storage"

Rules

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/cloud_connector"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.CloudConnector.Rules.List(context.TODO(), cloud_connector.RuleListParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  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": [
    {
      "id": "95c365e17e1b46599cd99e5b231fac4e",
      "description": "Rule description",
      "enabled": true,
      "expression": "http.cookie eq \"a=b\"",
      "parameters": {
        "host": "examplebucket.s3.eu-north-1.amazonaws.com"
      },
      "provider": "aws_s3"
    }
  ]
}

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": [
    {
      "id": "95c365e17e1b46599cd99e5b231fac4e",
      "description": "Rule description",
      "enabled": true,
      "expression": "http.cookie eq \"a=b\"",
      "parameters": {
        "host": "examplebucket.s3.eu-north-1.amazonaws.com"
      },
      "provider": "aws_s3"
    }
  ]
}