JSON object

Filters object structure and properties

A filter JSON object has the following structure:

{
    "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 table below summarizes the JSON object properties.

Property Description Value Notes
id - ID generated by Cloudflare 32-char UUIDv4 identifier - Unique
- Read-only
expression - A filter expression See expressions - Required
- Double quotes are escaped because of the double quoted JSON value
paused - Indicates if the filter is active

true

false

- Optional
- Default is false
description - To briefly describe the filter
- Omitted from object if empty
text

- Optional
- Default is empty

ref - Unique, user-supplied identifier or reference At user's discretion - Useful for identifying a filter if Cloudflare ID is unknown