Skip to content
Start here

Put Rules

cloud_connector.rules.update(RuleUpdateParams**kwargs) -> SyncSinglePage[RuleUpdateResponse]
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
zone_id: str

Identifier.

maxLength32
rules: Optional[Iterable[Rule]]
id: Optional[str]
description: Optional[str]
enabled: Optional[bool]
expression: Optional[str]
parameters: Optional[RuleParameters]

Parameters of Cloud Connector Rule

host: Optional[str]

Host to perform Cloud Connection to

provider: Optional[Literal["aws_s3", "cloudflare_r2", "gcp_storage", "azure_storage"]]

Cloud Provider type

One of the following:
"aws_s3"
"cloudflare_r2"
"gcp_storage"
"azure_storage"
ReturnsExpand Collapse
class RuleUpdateResponse:
id: Optional[str]
description: Optional[str]
enabled: Optional[bool]
expression: Optional[str]
parameters: Optional[Parameters]

Parameters of Cloud Connector Rule

host: Optional[str]

Host to perform Cloud Connection to

provider: Optional[Literal["aws_s3", "cloudflare_r2", "gcp_storage", "azure_storage"]]

Cloud Provider type

One of the following:
"aws_s3"
"cloudflare_r2"
"gcp_storage"
"azure_storage"

Put Rules

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud_connector.rules.update(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
{
  "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"
    }
  ]
}