---
title: Put Rules
---

[Skip to content](#_top)

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

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

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

Copy Markdown

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

---

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

# Put Rules

client.cloudConnector.rules.update(RuleUpdateParams {zone\_id, rules } params, RequestOptionsoptions?): SinglePage< [RuleUpdateResponse](<https://developers.cloudflare.com/api/typescript/resources/cloud_connector#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_update_response%20%3E%20(schema)>) {id, description, enabled, 3 more } >

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

Updates Cloud Connector rules for a zone, replacing the existing rule configuration.

##### 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

<details>

<summary>

params: RuleUpdateParams {zone\_id, rules }

</summary>

zone\_id: string

Path param: Identifier.

maxLength32

<a href="#(resource)%20cloud_connector.rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20zone_id">Link to this property</a>

<details>

<summary>

rules: Array&lt;Rule&gt;

Body param

</summary>

id?: string

<a href="#(resource)%20cloud_connector.rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

description?: string

<a href="#(resource)%20cloud_connector.rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20description">Link to this property</a>

enabled?: boolean

<a href="#(resource)%20cloud_connector.rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20enabled">Link to this property</a>

expression?: string

<a href="#(resource)%20cloud_connector.rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20expression">Link to this property</a>

<details>

<summary>

parameters?: Parameters {host }

Parameters of Cloud Connector Rule

</summary>

host?: string

Host to perform Cloud Connection to

<a href="#(resource)%20cloud_connector.rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%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(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20parameters">Link to this property</a>

<details>

<summary>

provider?: "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(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%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(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%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(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%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(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%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(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%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(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20provider">Link to this property</a>

</details>

<a href="#(resource)%20cloud_connector.rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20rules">Link to this property</a>

</details>

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

##### ReturnsExpand Collapse

<details>

<summary>

RuleUpdateResponse {id, description, enabled, 3 more }

</summary>

id?: string

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

description?: string

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

enabled?: boolean

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

expression?: string

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

<details>

<summary>

parameters?: Parameters {host }

Parameters of Cloud Connector Rule

</summary>

host?: string

Host to perform Cloud Connection to

<a href="#(resource)%20cloud_connector.rules%20%3E%20(model)%20rule_update_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_update_response%20%3E%20(schema)%20%3E%20(property)%20parameters">Link to this property</a>

<details>

<summary>

provider?: "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_update_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_update_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_update_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_update_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_update_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_update_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_update_response%20%3E%20(schema)>)

### Put Rules

TypeScript

HTTPTypeScriptPythonGoTerraform

```
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const ruleUpdateResponse of client.cloudConnector.rules.update({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
  rules: [{}],
})) {
  console.log(ruleUpdateResponse.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"
    }
  ]
}
```