Put Rules

client.CloudConnector.Rules.Update(ctx, params) (*SinglePage[RuleUpdateResponse], error)

PUT/zones/{zone_id}/cloud_connector/rules

Put 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 Write

ParametersExpand Collapse

params RuleUpdateParams

ZoneID param.Field[string]

Path param: Identifier.

maxLength32

Rules param.Field[[]RuleUpdateParamsRule]optional

Body param

ID stringoptional

Description stringoptional

Enabled booloptional

Expression stringoptional

Parameters RuleUpdateParamsRulesParametersoptional

Parameters of Cloud Connector Rule

Host stringoptional

Host to perform Cloud Connection to

Provider RuleUpdateParamsRulesProvideroptional

Cloud Provider type

One of the following:

const RuleUpdateParamsRulesProviderAwsS3 RuleUpdateParamsRulesProvider = "aws_s3"

const RuleUpdateParamsRulesProviderCloudflareR2 RuleUpdateParamsRulesProvider = "cloudflare_r2"

const RuleUpdateParamsRulesProviderGcpStorage RuleUpdateParamsRulesProvider = "gcp_storage"

const RuleUpdateParamsRulesProviderAzureStorage RuleUpdateParamsRulesProvider = "azure_storage"

ReturnsExpand Collapse

type RuleUpdateResponse struct{…}

ID stringoptional

Description stringoptional

Enabled booloptional

Expression stringoptional

Parameters RuleUpdateResponseParametersoptional

Parameters of Cloud Connector Rule

Host stringoptional

Host to perform Cloud Connection to

Provider RuleUpdateResponseProvideroptional

Cloud Provider type

One of the following:

const RuleUpdateResponseProviderAwsS3 RuleUpdateResponseProvider = "aws_s3"

const RuleUpdateResponseProviderCloudflareR2 RuleUpdateResponseProvider = "cloudflare_r2"

const RuleUpdateResponseProviderGcpStorage RuleUpdateResponseProvider = "gcp_storage"

const RuleUpdateResponseProviderAzureStorage RuleUpdateResponseProvider = "azure_storage"

Put 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.Update(context.TODO(), cloud_connector.RuleUpdateParams{
    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"
    }
  ]
}