JSON object
Ruleset object
A fully populated ruleset object has the following JSON structure.
{ "id": "ruleset_id", "name": "Example Ruleset", "description": Description of Example Ruleset", "kind": "managed", "version": "2", "rules": [ { "id": "rule-id", "version": "2", "action": "block", "expression": "cf.zone.name eq \"example.com\" ", "last_updated": "2020-07-20T10:44:29.124515Z" } ], "last_updated": "2020-07-20T10:44:29.124515Z", }Properties
The table lists the properties of a ruleset object
| Property | Description | Value | Notes |
|---|---|---|---|
id | Represents the unique Cloudflare-generated identifier for a given version of a ruleset | 32-character UUIDv4 string | Unique, read-only |
name | A human-readable name for the ruleset. | String | The name is immutable. You cannot change the name over the lifetime of the ruleset |
description | Optional description for the ruleset. | String | You can change the description over the lifetime of the ruleset. |
kind | The kind of ruleset the JSON object represents. | There are three kinds of ruleset:
| kind is immutable. |
version | The version of the ruleset | An integer value that starts at 1 and increments by 1 each time the ruleset is modified | Read-only |
rules | A list of rules to include in the ruleset | An array of JSON objects | |
last_updated | The time (UTC) when the ruleset was last updated | ISO 8601 timestamp in the format YYYY-MM-DDThh:mm:ss.TZD | Read-only |