# Rules

## Rules

`client.cloudConnector.rules.list(RuleListParamsparams, RequestOptionsoptions?): SinglePage<RuleListResponse>`

**get** `/zones/{zone_id}/cloud_connector/rules`

Rules

### Parameters

- `params: RuleListParams`

  - `zone_id: string`

    Identifier.

### Returns

- `RuleListResponse`

  - `id?: string`

  - `description?: string`

  - `enabled?: boolean`

  - `expression?: string`

  - `parameters?: Parameters`

    Parameters of Cloud Connector Rule

    - `host?: string`

      Host to perform Cloud Connection to

  - `provider?: "aws_s3" | "cloudflare_r2" | "gcp_storage" | "azure_storage"`

    Cloud Provider type

    - `"aws_s3"`

    - `"cloudflare_r2"`

    - `"gcp_storage"`

    - `"azure_storage"`

### Example

```node
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 ruleListResponse of client.cloudConnector.rules.list({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(ruleListResponse.id);
}
```

#### Response

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

## Put Rules

`client.cloudConnector.rules.update(RuleUpdateParamsparams, RequestOptionsoptions?): SinglePage<RuleUpdateResponse>`

**put** `/zones/{zone_id}/cloud_connector/rules`

Put Rules

### Parameters

- `params: RuleUpdateParams`

  - `zone_id: string`

    Path param: Identifier.

  - `rules?: Array<Rule>`

    Body param

    - `id?: string`

    - `description?: string`

    - `enabled?: boolean`

    - `expression?: string`

    - `parameters?: Parameters`

      Parameters of Cloud Connector Rule

      - `host?: string`

        Host to perform Cloud Connection to

    - `provider?: "aws_s3" | "cloudflare_r2" | "gcp_storage" | "azure_storage"`

      Cloud Provider type

      - `"aws_s3"`

      - `"cloudflare_r2"`

      - `"gcp_storage"`

      - `"azure_storage"`

### Returns

- `RuleUpdateResponse`

  - `id?: string`

  - `description?: string`

  - `enabled?: boolean`

  - `expression?: string`

  - `parameters?: Parameters`

    Parameters of Cloud Connector Rule

    - `host?: string`

      Host to perform Cloud Connection to

  - `provider?: "aws_s3" | "cloudflare_r2" | "gcp_storage" | "azure_storage"`

    Cloud Provider type

    - `"aws_s3"`

    - `"cloudflare_r2"`

    - `"gcp_storage"`

    - `"azure_storage"`

### Example

```node
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',
})) {
  console.log(ruleUpdateResponse.id);
}
```

#### Response

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

## Domain Types

### Rule List Response

- `RuleListResponse`

  - `id?: string`

  - `description?: string`

  - `enabled?: boolean`

  - `expression?: string`

  - `parameters?: Parameters`

    Parameters of Cloud Connector Rule

    - `host?: string`

      Host to perform Cloud Connection to

  - `provider?: "aws_s3" | "cloudflare_r2" | "gcp_storage" | "azure_storage"`

    Cloud Provider type

    - `"aws_s3"`

    - `"cloudflare_r2"`

    - `"gcp_storage"`

    - `"azure_storage"`

### Rule Update Response

- `RuleUpdateResponse`

  - `id?: string`

  - `description?: string`

  - `enabled?: boolean`

  - `expression?: string`

  - `parameters?: Parameters`

    Parameters of Cloud Connector Rule

    - `host?: string`

      Host to perform Cloud Connection to

  - `provider?: "aws_s3" | "cloudflare_r2" | "gcp_storage" | "azure_storage"`

    Cloud Provider type

    - `"aws_s3"`

    - `"cloudflare_r2"`

    - `"gcp_storage"`

    - `"azure_storage"`