---
description: Review the JSON structure for filter and rule objects.
title: JSON object
image: https://developers.cloudflare.com/og-docs.png
---

[Skip to content](#main-content)

> Documentation Index  
> Fetch the complete documentation index at: https://developers.cloudflare.com/firewall/llms.txt  
> Use this file to discover all available pages before exploring further.

# JSON object

Last updated Apr 24, 2026|Copy as Markdown|[View as Markdown](https://developers.cloudflare.com/firewall/api/cf-filters/json-object/index.md)|[Agent setup](https://developers.cloudflare.com/agent-setup/)

## Filter object structure and properties

A JSON response for the [Filters API](https://developers.cloudflare.com/api/resources/filters/methods/list/) has this structure:

```json
{
	"id": "6f58318e7fa2477a23112e8118c66f61",
	"expression": "http.request.uri.path ~ \"^.*/wp-login.php$\" or http.request.uri.path ~ \"^.*/xmlrpc.php$\"",
	"paused": true,
	"description": "WordPress login paths",
	"ref": ""
}
```

The following table summarizes the object properties:

| Property          | Description                                                                                                                                                                        | Constraints                            |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
| idString          | A UUIDv4 identifier generated by Cloudflare.                                                                                                                                       | Unique, read onlyLength: 32 characters |
| expressionString  | A Rules language expression used to evaluate requests. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/). |                                        |
| pausedBoolean     | Returns true when the filter is not active. Use ref to enable/disable the filter.                                                                                                  | Default: false                         |
| descriptionString | An informative summary of the filter.                                                                                                                                              | Maximum length: 500 characters         |
| refString         | A short string for tagging filters.                                                                                                                                                | Maximum length: 50 characters          |

Was this helpful?

YesNo

## On this page

[![](https://developers.cloudflare.com/_astro/logo.te5VL_aD.svg)Docs](https://developers.cloudflare.com/)

```json
{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/firewall/api/cf-filters/json-object/#page","headline":"Filter JSON object · Cloudflare Firewall Rules (deprecated) docs","description":"Review the JSON structure for filter and rule objects.","url":"https://developers.cloudflare.com/firewall/api/cf-filters/json-object/","inLanguage":"en","image":"https://developers.cloudflare.com/og-docs.png","dateModified":"2026-04-24","publisher":{"@type":"Organization","name":"Cloudflare","url":"https://www.cloudflare.com/"},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}
```