# Rules

## List zone snippet rules

`snippets.rules.list(RuleListParams**kwargs)  -> object`

**get** `/zones/{zone_id}/snippets/snippet_rules`

Fetches all snippet rules belonging to the zone.

### Parameters

- `zone_id: str`

  Use this field to specify the unique ID of the zone.

### Returns

- `object`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
rules = client.snippets.rules.list(
    zone_id="9f1839b6152d298aca64c4e906b6d074",
)
print(rules)
```

#### Response

```json
{
  "errors": [
    {
      "message": "something bad happened",
      "code": 10000
    }
  ],
  "messages": [
    {
      "message": "something bad happened",
      "code": 10000
    }
  ],
  "result": {},
  "success": true
}
```

## Update zone snippet rules

`snippets.rules.update(RuleUpdateParams**kwargs)  -> object`

**put** `/zones/{zone_id}/snippets/snippet_rules`

Updates all snippet rules belonging to the zone.

### Parameters

- `zone_id: str`

  Use this field to specify the unique ID of the zone.

- `rules: Iterable[Rule]`

  Lists snippet rules.

  - `id: str`

    Specify the unique ID of the rule.

  - `expression: str`

    Define the expression that determines which traffic matches the rule.

  - `last_updated: Union[str, datetime]`

    Specify the timestamp of when the rule was last modified.

  - `snippet_name: str`

    Identify the snippet.

  - `description: Optional[str]`

    Provide an informative description of the rule.

  - `enabled: Optional[bool]`

    Indicate whether to execute the rule.

### Returns

- `object`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
rule = client.snippets.rules.update(
    zone_id="9f1839b6152d298aca64c4e906b6d074",
    rules=[{
        "expression": "ip.src eq 1.1.1.1",
        "snippet_name": "my_snippet",
    }],
)
print(rule)
```

#### Response

```json
{
  "errors": [
    {
      "message": "something bad happened",
      "code": 10000
    }
  ],
  "messages": [
    {
      "message": "something bad happened",
      "code": 10000
    }
  ],
  "result": {},
  "success": true
}
```

## Delete zone snippet rules

`snippets.rules.delete(RuleDeleteParams**kwargs)  -> object`

**delete** `/zones/{zone_id}/snippets/snippet_rules`

Deletes all snippet rules belonging to the zone.

### Parameters

- `zone_id: str`

  Use this field to specify the unique ID of the zone.

### Returns

- `object`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
rule = client.snippets.rules.delete(
    zone_id="9f1839b6152d298aca64c4e906b6d074",
)
print(rule)
```

#### Response

```json
{
  "errors": [
    {
      "message": "something bad happened",
      "code": 10000
    }
  ],
  "messages": [
    {
      "message": "something bad happened",
      "code": 10000
    }
  ],
  "result": {},
  "success": true
}
```