---
title: Rules
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Cloud Connector](https://developers.cloudflare.com/api/python/resources/cloud_connector)

[Rules](https://developers.cloudflare.com/api/python/resources/cloud_connector/subresources/rules)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Rules

cloud\_connector.rules.list(RuleListParams\*\*kwargs) -> SyncSinglePage\[[RuleListResponse](<https://developers.cloudflare.com/api/python/resources/cloud_connector#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)>)]

GET/zones/{zone\_id}/cloud\_connector/rules

Retrieves the Cloud Connector rules configured for a zone. Rules define how traffic is routed to cloud services.

##### 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 Read``Cloud Connector Write`

##### ParametersExpand Collapse

zone\_id: str

Identifier.

maxLength32

[Link to this property](<#(resource)%20cloud_connector.rules%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class RuleListResponse: …

</summary>

id: Optional\[str]

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

description: Optional\[str]

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20description">Link to this property</a>

enabled: Optional\[bool]

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20enabled">Link to this property</a>

expression: Optional\[str]

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20expression">Link to this property</a>

<details>

<summary>

parameters: Optional\[Parameters]

Parameters of Cloud Connector Rule

</summary>

host: Optional\[str]

Host to perform Cloud Connection to

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20parameters%20%3E%20(property)%20host">Link to this property</a>

</details>

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20parameters">Link to this property</a>

<details>

<summary>

provider: Optional\[Literal\["aws\_s3", "cloudflare\_r2", "gcp\_storage", 2 more]]

Cloud Provider type

</summary>

One of the following:

"aws\_s3"

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20provider%20%3E%20(member)%200">Link to this property</a>

"cloudflare\_r2"

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20provider%20%3E%20(member)%201">Link to this property</a>

"gcp\_storage"

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20provider%20%3E%20(member)%202">Link to this property</a>

"azure\_storage"

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20provider%20%3E%20(member)%203">Link to this property</a>

"oci\_storage"

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20provider%20%3E%20(member)%204">Link to this property</a>

</details>

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20provider">Link to this property</a>

</details>

[Link to this property](<#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)>)

### Rules

Python

HTTPTypeScriptPythonGoTerraform

```
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.list(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
```

200 example

```
{
  "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

200 example

```
{
  "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"
    }
  ]
}
```