Filter JSON object
Filter object structure and properties
A JSON response for the Filters API has this structure:
The following table summarizes the object properties:
| Property | Description | Constraints |
|---|---|---|
idString |
A UUIDv4 identifier generated by Cloudflare. |
Unique, read only Length: 32 characters |
expressionString |
A Rules language expression used to evaluate requests. For more information, refer to Rule 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 |