Skip to main content
Glama

Update a zone ruleset

update_zone_ruleset
Destructive

Updates a Cloudflare zone ruleset by creating a new version, requiring explicit confirmation before each change.

Instructions

Updates a zone ruleset, creating a new version. Every change requires explicit confirmation; never repeat an unknown outcome automatically.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoExact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled.
confirmNoSet true only when the user asked for exactly this action.
dry_runNoValidates the request without persisting changes when set to `true`. Responses that normally return 200 return `result: null`; endpoints that normally return 204 continue to return 204.
payloadNoComplete current native JSON request body. Do not mix with payload_file.
zone_idNo
ruleset_idYes
payload_fileNoRegular non-symlink local JSON request file, at most 1 MiB. No credentials in public files.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed503 schema fields changedv3.0.1
    • addedInput schema / $defs / Remove_Directive
      Added value: +{
      +  "description": "Remove the directive.",
      +  "properties": {
      +    "cloudflare_only": {
      +      "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      +    },
      +    "operation": {
      +      "allOf": [
      +        {
      +          "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      +        },
      +        {
      +          "enum": [
      +            "remove"
      +          ],
      +          "type": "string"
      +        }
      +      ]
      +    }
      +  },
      +  "required": [
      +    "operation"
      +  ],
      +  "title": "Remove Directive",
      +  "type": "object"
      +}
    • changedInput schema / $defs / rulesets_SetCacheControlDirective / oneOf
      Previous value: -[
      -  {
      -    "description": "Set the directive.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "set"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Set Directive",
      -    "type": "object"
      -  },
      -  {
      -    "description": "Remove the directive.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "remove"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Remove Directive",
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "description": "Set the directive.",
      +    "properties": {
      +      "cloudflare_only": {
      +        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      +      },
      +      "operation": {
      +        "allOf": [
      +          {
      +            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      +          },
      +          {
      +            "enum": [
      +              "set"
      +            ],
      +            "type": "string"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "operation"
      +    ],
      +    "title": "Set Directive",
      +    "type": "object"
      +  },
      +  {
      +    "$ref": "#/$defs/Remove_Directive"
      +  }
      +]
    • changedInput schema / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / oneOf
      Previous value: -[
      -  {
      -    "description": "Set the directive with optional qualifiers.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "set"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      },
      -      "qualifiers": {
      -        "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).",
      -        "items": {
      -          "description": "A header name to qualify the directive.",
      -          "minLength": 1,
      -          "title": "Qualifier",
      -          "type": "string"
      -        },
      -        "title": "Qualifiers",
      -        "type": "array",
      -        "uniqueItems": true
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Set Directive",
      -    "type": "object"
      -  },
      -  {
      -    "description": "Remove the directive.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "remove"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Remove Directive",
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "description": "Set the directive with optional qualifiers.",
      +    "properties": {
      +      "cloudflare_only": {
      +        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      +      },
      +      "operation": {
      +        "allOf": [
      +          {
      +            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      +          },
      +          {
      +            "enum": [
      +              "set"
      +            ],
      +            "type": "string"
      +          }
      +        ]
      +      },
      +      "qualifiers": {
      +        "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).",
      +        "items": {
      +          "description": "A header name to qualify the directive.",
      +          "minLength": 1,
      +          "title": "Qualifier",
      +          "type": "string"
      +        },
      +        "title": "Qualifiers",
      +        "type": "array",
      +        "uniqueItems": true
      +      }
      +    },
      +    "required": [
      +      "operation"
      +    ],
      +    "title": "Set Directive",
      +    "type": "object"
      +  },
      +  {
      +    "$ref": "#/$defs/Remove_Directive"
      +  }
      +]
    • changedInput schema / $defs / rulesets_SetCacheControlDirectiveWithValue / oneOf
      Previous value: -[
      -  {
      -    "description": "Set the directive with a duration value in seconds.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "set"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      },
      -      "value": {
      -        "description": "The duration value in seconds for the directive.",
      -        "minimum": 0,
      -        "title": "Value",
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "value"
      -    ],
      -    "title": "Set Directive",
      -    "type": "object"
      -  },
      -  {
      -    "description": "Remove the directive.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "remove"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Remove Directive",
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "description": "Set the directive with a duration value in seconds.",
      +    "properties": {
      +      "cloudflare_only": {
      +        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      +      },
      +      "operation": {
      +        "allOf": [
      +          {
      +            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      +          },
      +          {
      +            "enum": [
      +              "set"
      +            ],
      +            "type": "string"
      +          }
      +        ]
      +      },
      +      "value": {
      +        "description": "The duration value in seconds for the directive.",
      +        "minimum": 0,
      +        "title": "Value",
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "value"
      +    ],
      +    "title": "Set Directive",
      +    "type": "object"
      +  },
      +  {
      +    "$ref": "#/$defs/Remove_Directive"
      +  }
      +]
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / payload / $defs / rulesets_BlockRule / $ref
      Added value: +"#/$defs/rulesets_BlockRule"
    • removedInput schema / properties / payload / $defs / rulesets_BlockRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "block"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "properties": {
      -          "response": {
      -            "description": "The response to show when the block is applied.",
      -            "properties": {
      -              "content": {
      -                "description": "The content to return.",
      -                "minLength": 1,
      -                "title": "Content",
      -                "type": "string"
      -              },
      -              "content_type": {
      -                "description": "The type of the content to return.",
      -                "minLength": 1,
      -                "title": "Content Type",
      -                "type": "string"
      -              },
      -              "status_code": {
      -                "description": "The status code to return.",
      -                "maximum": 499,
      -                "minimum": 400,
      -                "title": "Status Code",
      -                "type": "integer"
      -              }
      -            },
      -            "required": [
      -              "status_code",
      -              "content",
      -              "content_type"
      -            ],
      -            "title": "Response",
      -            "type": "object"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Block Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_ChallengeRule / $ref
      Added value: +"#/$defs/rulesets_ChallengeRule"
    • removedInput schema / properties / payload / $defs / rulesets_ChallengeRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "challenge"
      -        ],
      -        "type": "string"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Challenge Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_CompressResponseRule / $ref
      Added value: +"#/$defs/rulesets_CompressResponseRule"
    • removedInput schema / properties / payload / $defs / rulesets_CompressResponseRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "compress_response"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "properties": {
      -          "algorithms": {
      -            "description": "Custom order for compression algorithms.",
      -            "items": {
      -              "description": "Compression algorithm to enable.",
      -              "properties": {
      -                "name": {
      -                  "description": "Name of the compression algorithm to enable.",
      -                  "enum": [
      -                    "none",
      -                    "auto",
      -                    "default",
      -                    "gzip",
      -                    "brotli",
      -                    "zstd"
      -                  ],
      -                  "title": "Algorithm Name",
      -                  "type": "string"
      -                }
      -              },
      -              "title": "Algorithm",
      -              "type": "object"
      -            },
      -            "minItems": 1,
      -            "title": "Algorithms",
      -            "type": "array",
      -            "uniqueItems": true
      -          }
      -        },
      -        "required": [
      -          "algorithms"
      -        ],
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Response Compression Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_DDoSDynamicRule / $ref
      Added value: +"#/$defs/rulesets_DDoSDynamicRule"
    • removedInput schema / properties / payload / $defs / rulesets_DDoSDynamicRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "ddos_dynamic"
      -        ],
      -        "type": "string"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "DDoS Dynamic Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / $ref
      Added value: +"#/$defs/rulesets_ExecuteCategoryOverrides"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / description
      Removed value: -"A list of category-level overrides. This option has the second-highest precedence after rule-level overrides."
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / items
      Removed value: -{
      -  "description": "A category-level override.",
      -  "minProperties": 2,
      -  "properties": {
      -    "action": {
      -      "allOf": [
      -        {
      -          "$ref": "#/$defs/rulesets_RuleAction"
      -        },
      -        {
      -          "description": "The action to override rules in the category with.",
      -          "type": "string"
      -        }
      -      ]
      -    },
      -    "category": {
      -      "allOf": [
      -        {
      -          "$ref": "#/$defs/rulesets_RuleCategory"
      -        },
      -        {
      -          "description": "The name of the category to override.",
      -          "type": "string"
      -        }
      -      ]
      -    },
      -    "enabled": {
      -      "allOf": [
      -        {
      -          "$ref": "#/$defs/rulesets_RuleEnabled"
      -        },
      -        {
      -          "description": "Whether to enable execution of rules in the category.",
      -          "type": "boolean"
      -        }
      -      ]
      -    },
      -    "sensitivity_level": {
      -      "allOf": [
      -        {
      -          "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel"
      -        },
      -        {
      -          "description": "The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases.",
      -          "type": "string"
      -        }
      -      ]
      -    }
      -  },
      -  "required": [
      -    "category"
      -  ],
      -  "title": "Category Override",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / title
      Removed value: -"Category Overrides"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / type
      Removed value: -"array"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / uniqueItems
      Removed value: -true
    • addedInput schema / properties / payload / $defs / rulesets_ExecuteMatchedData / $ref
      Added value: +"#/$defs/rulesets_ExecuteMatchedData"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteMatchedData / description
      Removed value: -"The configuration to use for matched data logging."
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteMatchedData / properties
      Removed value: -{
      -  "public_key": {
      -    "description": "The public key to encrypt matched data logs with.",
      -    "minLength": 1,
      -    "title": "Public Key",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteMatchedData / required
      Removed value: -[
      -  "public_key"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteMatchedData / title
      Removed value: -"Matched Data"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteMatchedData / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_ExecuteOverrides / $ref
      Added value: +"#/$defs/rulesets_ExecuteOverrides"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteOverrides / description
      Removed value: -"A set of overrides to apply to the target ruleset."
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteOverrides / minProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteOverrides / properties
      Removed value: -{
      -  "action": {
      -    "allOf": [
      -      {
      -        "$ref": "#/$defs/rulesets_RuleAction"
      -      },
      -      {
      -        "description": "An action to override all rules with. This option has lower precedence than rule and category overrides.",
      -        "type": "string"
      -      }
      -    ]
      -  },
      -  "categories": {
      -    "$ref": "#/$defs/rulesets_ExecuteCategoryOverrides"
      -  },
      -  "enabled": {
      -    "allOf": [
      -      {
      -        "$ref": "#/$defs/rulesets_RuleEnabled"
      -      },
      -      {
      -        "description": "Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.",
      -        "type": "boolean"
      -      }
      -    ]
      -  },
      -  "rules": {
      -    "$ref": "#/$defs/rulesets_ExecuteRuleOverrides"
      -  },
      -  "sensitivity_level": {
      -    "allOf": [
      -      {
      -        "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel"
      -      },
      -      {
      -        "description": "A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases.",
      -        "type": "string"
      -      }
      -    ]
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteOverrides / title
      Removed value: -"Overrides"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteOverrides / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_ExecuteRule / $ref
      Added value: +"#/$defs/rulesets_ExecuteRule"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "execute"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "properties": {
      -          "id": {
      -            "allOf": [
      -              {
      -                "$ref": "#/$defs/rulesets_RulesetId"
      -              },
      -              {
      -                "description": "The ID of the ruleset to execute.",
      -                "type": "string"
      -              }
      -            ]
      -          },
      -          "matched_data": {
      -            "$ref": "#/$defs/rulesets_ExecuteMatchedData"
      -          },
      -          "overrides": {
      -            "$ref": "#/$defs/rulesets_ExecuteOverrides"
      -          }
      -        },
      -        "required": [
      -          "id"
      -        ],
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Execute Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / $ref
      Added value: +"#/$defs/rulesets_ExecuteRuleOverrides"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / description
      Removed value: -"A list of rule-level overrides. This option has the highest precedence."
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / items
      Removed value: -{
      -  "description": "A rule-level override.",
      -  "minProperties": 2,
      -  "properties": {
      -    "action": {
      -      "allOf": [
      -        {
      -          "$ref": "#/$defs/rulesets_RuleAction"
      -        },
      -        {
      -          "description": "The action to override the rule with.",
      -          "type": "string"
      -        }
      -      ]
      -    },
      -    "enabled": {
      -      "allOf": [
      -        {
      -          "$ref": "#/$defs/rulesets_RuleEnabled"
      -        },
      -        {
      -          "description": "Whether to enable execution of the rule.",
      -          "type": "boolean"
      -        }
      -      ]
      -    },
      -    "id": {
      -      "allOf": [
      -        {
      -          "$ref": "#/$defs/rulesets_RuleId"
      -        },
      -        {
      -          "description": "The ID of the rule to override.",
      -          "type": "string"
      -        }
      -      ]
      -    },
      -    "score_threshold": {
      -      "description": "The score threshold to use for the rule.",
      -      "title": "Score Threshold",
      -      "type": "integer"
      -    },
      -    "sensitivity_level": {
      -      "allOf": [
      -        {
      -          "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel"
      -        },
      -        {
      -          "description": "The sensitivity level to use for the rule. This option is only applicable for DDoS phases.",
      -          "type": "string"
      -        }
      -      ]
      -    }
      -  },
      -  "required": [
      -    "id"
      -  ],
      -  "title": "Rule Override",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / title
      Removed value: -"Rule Overrides"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / type
      Removed value: -"array"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / uniqueItems
      Removed value: -true
    • addedInput schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / $ref
      Added value: +"#/$defs/rulesets_ExecuteSensitivityLevel"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / enum
      Removed value: -[
      -  "default",
      -  "medium",
      -  "low",
      -  "eoff"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / title
      Removed value: -"Sensitivity Level"
    • removedInput schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_ForceConnectionCloseRule / $ref
      Added value: +"#/$defs/rulesets_ForceConnectionCloseRule"
    • removedInput schema / properties / payload / $defs / rulesets_ForceConnectionCloseRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "force_connection_close"
      -        ],
      -        "type": "string"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Force Connection Close Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_JsChallengeRule / $ref
      Added value: +"#/$defs/rulesets_JsChallengeRule"
    • removedInput schema / properties / payload / $defs / rulesets_JsChallengeRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "js_challenge"
      -        ],
      -        "type": "string"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "JavaScript Challenge Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / $ref
      Added value: +"#/$defs/rulesets_LogCustomFieldCookieFields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / description
      Removed value: -"The cookie fields to log."
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / items
      Removed value: -{
      -  "description": "The cookie field to log.",
      -  "properties": {
      -    "name": {
      -      "description": "The name of the cookie.",
      -      "minLength": 1,
      -      "title": "Cookie Name",
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "name"
      -  ],
      -  "title": "Cookie Field",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / title
      Removed value: -"Cookie Fields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / type
      Removed value: -"array"
    • addedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / $ref
      Added value: +"#/$defs/rulesets_LogCustomFieldRawResponseFields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / description
      Removed value: -"The raw response fields to log."
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / items
      Removed value: -{
      -  "description": "The raw response field to log.",
      -  "properties": {
      -    "name": {
      -      "description": "The name of the response header.",
      -      "minLength": 1,
      -      "title": "Header Name",
      -      "type": "string"
      -    },
      -    "preserve_duplicates": {
      -      "default": false,
      -      "description": "Whether to log duplicate values of the same header.",
      -      "title": "Preserve Duplicates",
      -      "type": "boolean"
      -    }
      -  },
      -  "required": [
      -    "name"
      -  ],
      -  "title": "Raw Response Field",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / title
      Removed value: -"Raw Response Fields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / type
      Removed value: -"array"
    • addedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / $ref
      Added value: +"#/$defs/rulesets_LogCustomFieldRequestFields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / description
      Removed value: -"The raw request fields to log."
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / items
      Removed value: -{
      -  "description": "The raw request field to log.",
      -  "properties": {
      -    "name": {
      -      "description": "The name of the header.",
      -      "minLength": 1,
      -      "title": "Header Name",
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "name"
      -  ],
      -  "title": "Raw Request Field",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / title
      Removed value: -"Raw Request Fields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / type
      Removed value: -"array"
    • addedInput schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / $ref
      Added value: +"#/$defs/rulesets_LogCustomFieldResponseFields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / description
      Removed value: -"The transformed response fields to log."
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / items
      Removed value: -{
      -  "description": "The transformed response field to log.",
      -  "properties": {
      -    "name": {
      -      "description": "The name of the response header.",
      -      "minLength": 1,
      -      "title": "Header Name",
      -      "type": "string"
      -    },
      -    "preserve_duplicates": {
      -      "default": false,
      -      "description": "Whether to log duplicate values of the same header.",
      -      "title": "Preserve Duplicates",
      -      "type": "boolean"
      -    }
      -  },
      -  "required": [
      -    "name"
      -  ],
      -  "title": "Transformed Response Field",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / title
      Removed value: -"Transformed Response Fields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / type
      Removed value: -"array"
    • addedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRule / $ref
      Added value: +"#/$defs/rulesets_LogCustomFieldRule"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "log_custom_field"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "minProperties": 1,
      -        "properties": {
      -          "cookie_fields": {
      -            "$ref": "#/$defs/rulesets_LogCustomFieldCookieFields"
      -          },
      -          "raw_response_fields": {
      -            "$ref": "#/$defs/rulesets_LogCustomFieldRawResponseFields"
      -          },
      -          "request_fields": {
      -            "$ref": "#/$defs/rulesets_LogCustomFieldRequestFields"
      -          },
      -          "response_fields": {
      -            "$ref": "#/$defs/rulesets_LogCustomFieldResponseFields"
      -          },
      -          "transformed_request_fields": {
      -            "$ref": "#/$defs/rulesets_LogCustomFieldTransformedRequestFields"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Log Custom Field Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / $ref
      Added value: +"#/$defs/rulesets_LogCustomFieldTransformedRequestFields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / description
      Removed value: -"The transformed request fields to log."
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / items
      Removed value: -{
      -  "description": "The transformed request field to log.",
      -  "properties": {
      -    "name": {
      -      "description": "The name of the header.",
      -      "minLength": 1,
      -      "title": "Header Name",
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "name"
      -  ],
      -  "title": "Transformed Request Field",
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / title
      Removed value: -"Transformed Request Fields"
    • removedInput schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / type
      Removed value: -"array"
    • addedInput schema / properties / payload / $defs / rulesets_LogRule / $ref
      Added value: +"#/$defs/rulesets_LogRule"
    • removedInput schema / properties / payload / $defs / rulesets_LogRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "log"
      -        ],
      -        "type": "string"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Log Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_ManagedChallengeRule / $ref
      Added value: +"#/$defs/rulesets_ManagedChallengeRule"
    • removedInput schema / properties / payload / $defs / rulesets_ManagedChallengeRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "managed_challenge"
      -        ],
      -        "type": "string"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Managed Challenge Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_RedirectFromList / $ref
      Added value: +"#/$defs/rulesets_RedirectFromList"
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromList / description
      Removed value: -"A redirect based on a bulk list lookup."
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromList / properties
      Removed value: -{
      -  "key": {
      -    "description": "An expression that evaluates to the list lookup key.",
      -    "minLength": 1,
      -    "title": "Lookup Key",
      -    "type": "string"
      -  },
      -  "name": {
      -    "description": "The name of the list to match against.",
      -    "pattern": "^[a-zA-Z0-9_]+$",
      -    "title": "List Name",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromList / required
      Removed value: -[
      -  "name",
      -  "key"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromList / title
      Removed value: -"Bulk Redirect"
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromList / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RedirectFromValue / $ref
      Added value: +"#/$defs/rulesets_RedirectFromValue"
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromValue / description
      Removed value: -"A redirect based on the request properties."
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromValue / properties
      Removed value: -{
      -  "preserve_query_string": {
      -    "default": false,
      -    "description": "Whether to keep the query string of the original request.",
      -    "title": "Preserve Query String",
      -    "type": "boolean"
      -  },
      -  "status_code": {
      -    "description": "The status code to use for the redirect.",
      -    "enum": [
      -      301,
      -      302,
      -      303,
      -      307,
      -      308
      -    ],
      -    "title": "Status Code",
      -    "type": "integer"
      -  },
      -  "target_url": {
      -    "description": "A URL to redirect the request to.",
      -    "maxProperties": 1,
      -    "minProperties": 1,
      -    "properties": {
      -      "expression": {
      -        "description": "An expression that evaluates to a URL to redirect the request to.",
      -        "minLength": 1,
      -        "title": "Redirect Expression",
      -        "type": "string"
      -      },
      -      "value": {
      -        "description": "A URL to redirect the request to.",
      -        "minLength": 1,
      -        "title": "Redirect Value",
      -        "type": "string"
      -      }
      -    },
      -    "title": "Target URL",
      -    "type": "object"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromValue / required
      Removed value: -[
      -  "target_url"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromValue / title
      Removed value: -"Single Redirect"
    • removedInput schema / properties / payload / $defs / rulesets_RedirectFromValue / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RedirectRule / $ref
      Added value: +"#/$defs/rulesets_RedirectRule"
    • removedInput schema / properties / payload / $defs / rulesets_RedirectRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "redirect"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "maxProperties": 1,
      -        "minProperties": 1,
      -        "properties": {
      -          "from_list": {
      -            "$ref": "#/$defs/rulesets_RedirectFromList"
      -          },
      -          "from_value": {
      -            "$ref": "#/$defs/rulesets_RedirectFromValue"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Redirect Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_RequestRule / $ref
      Added value: +"#/$defs/rulesets_RequestRule"
    • removedInput schema / properties / payload / $defs / rulesets_RequestRule / oneOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_BlockRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_ChallengeRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_CompressResponseRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_DDoSDynamicRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_ExecuteRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_ForceConnectionCloseRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_JsChallengeRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_LogRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_LogCustomFieldRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_ManagedChallengeRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_RedirectRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_RewriteRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_RouteRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_ScoreRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_ServeErrorRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_SetCacheControlRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_SetCacheTagsRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_SetConfigRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_SkipRule"
      -  },
      -  {
      -    "$ref": "#/$defs/rulesets_TransformResponseHTMLRule"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_RequestRules / $ref
      Added value: +"#/$defs/rulesets_RequestRules"
    • removedInput schema / properties / payload / $defs / rulesets_RequestRules / default
      Removed value: -[]
    • removedInput schema / properties / payload / $defs / rulesets_RequestRules / description
      Removed value: -"The list of rules in the ruleset."
    • removedInput schema / properties / payload / $defs / rulesets_RequestRules / items
      Removed value: -{
      -  "$ref": "#/$defs/rulesets_RequestRule"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RequestRules / title
      Removed value: -"Rules"
    • removedInput schema / properties / payload / $defs / rulesets_RequestRules / type
      Removed value: -"array"
    • addedInput schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / $ref
      Added value: +"#/$defs/rulesets_RewriteHeaderExpression"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / description
      Removed value: -"An expression that evaluates to a value for the header."
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / minLength
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / title
      Removed value: -"Header Expression"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / $ref
      Added value: +"#/$defs/rulesets_RewriteHeaderOperation"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / description
      Removed value: -"The operation to perform on the header."
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / title
      Removed value: -"Operation"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RewriteHeaderValue / $ref
      Added value: +"#/$defs/rulesets_RewriteHeaderValue"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderValue / description
      Removed value: -"A static value for the header."
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderValue / minLength
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderValue / title
      Removed value: -"Header Value"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaderValue / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RewriteHeaders / $ref
      Added value: +"#/$defs/rulesets_RewriteHeaders"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaders / additionalProperties
      Removed value: -{
      -  "oneOf": [
      -    {
      -      "description": "A header with a static value to add.",
      -      "properties": {
      -        "operation": {
      -          "allOf": [
      -            {
      -              "$ref": "#/$defs/rulesets_RewriteHeaderOperation"
      -            },
      -            {
      -              "enum": [
      -                "add"
      -              ],
      -              "type": "string"
      -            }
      -          ]
      -        },
      -        "value": {
      -          "$ref": "#/$defs/rulesets_RewriteHeaderValue"
      -        }
      -      },
      -      "required": [
      -        "operation",
      -        "value"
      -      ],
      -      "title": "Add Static Header",
      -      "type": "object"
      -    },
      -    {
      -      "description": "A header with a dynamic value to add.",
      -      "properties": {
      -        "expression": {
      -          "$ref": "#/$defs/rulesets_RewriteHeaderExpression"
      -        },
      -        "operation": {
      -          "allOf": [
      -            {
      -              "$ref": "#/$defs/rulesets_RewriteHeaderOperation"
      -            },
      -            {
      -              "enum": [
      -                "add"
      -              ],
      -              "type": "string"
      -            }
      -          ]
      -        }
      -      },
      -      "required": [
      -        "operation",
      -        "expression"
      -      ],
      -      "title": "Add Dynamic Header",
      -      "type": "object"
      -    },
      -    {
      -      "description": "A header with a static value to set.",
      -      "properties": {
      -        "operation": {
      -          "allOf": [
      -            {
      -              "$ref": "#/$defs/rulesets_RewriteHeaderOperation"
      -            },
      -            {
      -              "enum": [
      -                "set"
      -              ],
      -              "type": "string"
      -            }
      -          ]
      -        },
      -        "value": {
      -          "$ref": "#/$defs/rulesets_RewriteHeaderValue"
      -        }
      -      },
      -      "required": [
      -        "operation",
      -        "value"
      -      ],
      -      "title": "Set Static Header",
      -      "type": "object"
      -    },
      -    {
      -      "description": "A header with a dynamic value to set.",
      -      "properties": {
      -        "expression": {
      -          "$ref": "#/$defs/rulesets_RewriteHeaderExpression"
      -        },
      -        "operation": {
      -          "allOf": [
      -            {
      -              "$ref": "#/$defs/rulesets_RewriteHeaderOperation"
      -            },
      -            {
      -              "enum": [
      -                "set"
      -              ],
      -              "type": "string"
      -            }
      -          ]
      -        }
      -      },
      -      "required": [
      -        "operation",
      -        "expression"
      -      ],
      -      "title": "Set Dynamic Header",
      -      "type": "object"
      -    },
      -    {
      -      "description": "A header to remove.",
      -      "properties": {
      -        "operation": {
      -          "allOf": [
      -            {
      -              "$ref": "#/$defs/rulesets_RewriteHeaderOperation"
      -            },
      -            {
      -              "enum": [
      -                "remove"
      -              ],
      -              "type": "string"
      -            }
      -          ]
      -        }
      -      },
      -      "required": [
      -        "operation"
      -      ],
      -      "title": "Remove Header",
      -      "type": "object"
      -    }
      -  ]
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaders / description
      Removed value: -"A map of headers to rewrite."
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaders / minProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaders / title
      Removed value: -"Headers"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteHeaders / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RewriteRule / $ref
      Added value: +"#/$defs/rulesets_RewriteRule"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "rewrite"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "minProperties": 1,
      -        "properties": {
      -          "headers": {
      -            "$ref": "#/$defs/rulesets_RewriteHeaders"
      -          },
      -          "uri": {
      -            "$ref": "#/$defs/rulesets_RewriteUri"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Rewrite Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_RewriteUri / $ref
      Added value: +"#/$defs/rulesets_RewriteUri"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUri / allOf
      Removed value: -[
      -  {
      -    "anyOf": [
      -      {
      -        "description": "A URI path rewrite.",
      -        "properties": {
      -          "path": {
      -            "$ref": "#/$defs/rulesets_RewriteUriPath"
      -          }
      -        },
      -        "required": [
      -          "path"
      -        ],
      -        "title": "URI Path",
      -        "type": "object"
      -      },
      -      {
      -        "description": "A URI query rewrite.",
      -        "properties": {
      -          "query": {
      -            "$ref": "#/$defs/rulesets_RewriteUriQuery"
      -          }
      -        },
      -        "required": [
      -          "query"
      -        ],
      -        "title": "URI Query",
      -        "type": "object"
      -      }
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "origin": {
      -        "description": "Whether to propagate the rewritten URI to origin.",
      -        "title": "Origin",
      -        "type": "boolean"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_RewriteUriPath / $ref
      Added value: +"#/$defs/rulesets_RewriteUriPath"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriPath / description
      Removed value: -"A URI path rewrite."
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriPath / maxProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriPath / minProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriPath / properties
      Removed value: -{
      -  "expression": {
      -    "description": "An expression that evaluates to a value to rewrite the URI path to.",
      -    "minLength": 1,
      -    "title": "Path Expression",
      -    "type": "string"
      -  },
      -  "value": {
      -    "description": "A value to rewrite the URI path to.",
      -    "minLength": 1,
      -    "title": "Path Value",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriPath / title
      Removed value: -"URI Path"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriPath / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RewriteUriQuery / $ref
      Added value: +"#/$defs/rulesets_RewriteUriQuery"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriQuery / description
      Removed value: -"A URI query rewrite."
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriQuery / maxProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriQuery / minProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriQuery / properties
      Removed value: -{
      -  "expression": {
      -    "description": "An expression that evaluates to a value to rewrite the URI query to.",
      -    "minLength": 1,
      -    "title": "Query Expression",
      -    "type": "string"
      -  },
      -  "value": {
      -    "description": "A value to rewrite the URI query to.",
      -    "title": "Query Value",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriQuery / title
      Removed value: -"URI Query"
    • removedInput schema / properties / payload / $defs / rulesets_RewriteUriQuery / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RouteHostHeader / $ref
      Added value: +"#/$defs/rulesets_RouteHostHeader"
    • removedInput schema / properties / payload / $defs / rulesets_RouteHostHeader / description
      Removed value: -"A value to rewrite the HTTP host header to."
    • removedInput schema / properties / payload / $defs / rulesets_RouteHostHeader / minLength
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RouteHostHeader / title
      Removed value: -"Host Header"
    • removedInput schema / properties / payload / $defs / rulesets_RouteHostHeader / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RouteOrigin / $ref
      Added value: +"#/$defs/rulesets_RouteOrigin"
    • removedInput schema / properties / payload / $defs / rulesets_RouteOrigin / description
      Removed value: -"An origin to route to."
    • removedInput schema / properties / payload / $defs / rulesets_RouteOrigin / minProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RouteOrigin / properties
      Removed value: -{
      -  "host": {
      -    "description": "A resolved host to route to.",
      -    "minLength": 1,
      -    "title": "Host",
      -    "type": "string"
      -  },
      -  "port": {
      -    "description": "A destination port to route to.",
      -    "maximum": 65535,
      -    "minimum": 1,
      -    "title": "Port",
      -    "type": "integer"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RouteOrigin / title
      Removed value: -"Origin"
    • removedInput schema / properties / payload / $defs / rulesets_RouteOrigin / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RouteRule / $ref
      Added value: +"#/$defs/rulesets_RouteRule"
    • removedInput schema / properties / payload / $defs / rulesets_RouteRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "route"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "minProperties": 1,
      -        "properties": {
      -          "host_header": {
      -            "$ref": "#/$defs/rulesets_RouteHostHeader"
      -          },
      -          "origin": {
      -            "$ref": "#/$defs/rulesets_RouteOrigin"
      -          },
      -          "sni": {
      -            "$ref": "#/$defs/rulesets_RouteSNI"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Route Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_RouteSNI / $ref
      Added value: +"#/$defs/rulesets_RouteSNI"
    • removedInput schema / properties / payload / $defs / rulesets_RouteSNI / description
      Removed value: -"A Server Name Indication (SNI) override."
    • removedInput schema / properties / payload / $defs / rulesets_RouteSNI / properties
      Removed value: -{
      -  "value": {
      -    "description": "A value to override the SNI to.",
      -    "minLength": 1,
      -    "title": "Value",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RouteSNI / required
      Removed value: -[
      -  "value"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_RouteSNI / title
      Removed value: -"Server Name Indication"
    • removedInput schema / properties / payload / $defs / rulesets_RouteSNI / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_Rule / $ref
      Added value: +"#/$defs/rulesets_Rule"
    • removedInput schema / properties / payload / $defs / rulesets_Rule / properties
      Removed value: -{
      -  "action": {
      -    "$ref": "#/$defs/rulesets_RuleAction"
      -  },
      -  "action_parameters": {
      -    "default": {},
      -    "description": "The parameters configuring the rule's action.",
      -    "title": "Action Parameters",
      -    "type": "object"
      -  },
      -  "categories": {
      -    "$ref": "#/$defs/rulesets_RuleCategories"
      -  },
      -  "description": {
      -    "default": "",
      -    "description": "An informative description of the rule.",
      -    "title": "Description",
      -    "type": "string"
      -  },
      -  "enabled": {
      -    "allOf": [
      -      {
      -        "$ref": "#/$defs/rulesets_RuleEnabled"
      -      },
      -      {
      -        "default": true,
      -        "type": "boolean"
      -      }
      -    ]
      -  },
      -  "exposed_credential_check": {
      -    "$ref": "#/$defs/rulesets_RuleExposedCredentialCheck"
      -  },
      -  "expression": {
      -    "description": "The expression defining which traffic will match the rule.",
      -    "minLength": 1,
      -    "title": "Expression",
      -    "type": "string"
      -  },
      -  "id": {
      -    "$ref": "#/$defs/rulesets_RuleId"
      -  },
      -  "last_updated": {
      -    "description": "The timestamp of when the rule was last modified.",
      -    "format": "date-time",
      -    "title": "Last Updated",
      -    "type": "string"
      -  },
      -  "logging": {
      -    "$ref": "#/$defs/rulesets_RuleLogging"
      -  },
      -  "ratelimit": {
      -    "$ref": "#/$defs/rulesets_RuleRatelimit"
      -  },
      -  "ref": {
      -    "description": "The reference of the rule (the rule's ID by default).",
      -    "minLength": 1,
      -    "title": "Ref",
      -    "type": "string"
      -  },
      -  "version": {
      -    "description": "The version of the rule.",
      -    "pattern": "^[0-9]+$",
      -    "title": "Version",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_Rule / required
      Removed value: -[
      -  "version",
      -  "last_updated"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_Rule / title
      Removed value: -"Rule"
    • removedInput schema / properties / payload / $defs / rulesets_Rule / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RuleAction / $ref
      Added value: +"#/$defs/rulesets_RuleAction"
    • removedInput schema / properties / payload / $defs / rulesets_RuleAction / description
      Removed value: -"The action to perform when the rule matches."
    • removedInput schema / properties / payload / $defs / rulesets_RuleAction / pattern
      Removed value: -"^[a-z_]+$"
    • removedInput schema / properties / payload / $defs / rulesets_RuleAction / title
      Removed value: -"Action"
    • removedInput schema / properties / payload / $defs / rulesets_RuleAction / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RuleCategories / $ref
      Added value: +"#/$defs/rulesets_RuleCategories"
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategories / description
      Removed value: -"The categories of the rule."
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategories / items
      Removed value: -{
      -  "$ref": "#/$defs/rulesets_RuleCategory"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategories / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategories / title
      Removed value: -"Categories"
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategories / type
      Removed value: -"array"
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategories / uniqueItems
      Removed value: -true
    • addedInput schema / properties / payload / $defs / rulesets_RuleCategory / $ref
      Added value: +"#/$defs/rulesets_RuleCategory"
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategory / description
      Removed value: -"The category of a rule."
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategory / minLength
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategory / title
      Removed value: -"Category"
    • removedInput schema / properties / payload / $defs / rulesets_RuleCategory / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RuleEnabled / $ref
      Added value: +"#/$defs/rulesets_RuleEnabled"
    • removedInput schema / properties / payload / $defs / rulesets_RuleEnabled / description
      Removed value: -"Whether the rule should be executed."
    • removedInput schema / properties / payload / $defs / rulesets_RuleEnabled / title
      Removed value: -"Enabled"
    • removedInput schema / properties / payload / $defs / rulesets_RuleEnabled / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / $ref
      Added value: +"#/$defs/rulesets_RuleExposedCredentialCheck"
    • removedInput schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / description
      Removed value: -"Configuration for exposed credential checking."
    • removedInput schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / properties
      Removed value: -{
      -  "password_expression": {
      -    "description": "An expression that selects the password used in the credentials check.",
      -    "minLength": 1,
      -    "title": "Password Expression",
      -    "type": "string"
      -  },
      -  "username_expression": {
      -    "description": "An expression that selects the user ID used in the credentials check.",
      -    "minLength": 1,
      -    "title": "Username Expression",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / required
      Removed value: -[
      -  "username_expression",
      -  "password_expression"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / title
      Removed value: -"Exposed Credential Check"
    • removedInput schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RuleId / $ref
      Added value: +"#/$defs/rulesets_RuleId"
    • removedInput schema / properties / payload / $defs / rulesets_RuleId / description
      Removed value: -"The unique ID of the rule."
    • removedInput schema / properties / payload / $defs / rulesets_RuleId / pattern
      Removed value: -"^[0-9a-f]{32}$"
    • removedInput schema / properties / payload / $defs / rulesets_RuleId / title
      Removed value: -"Rule ID"
    • removedInput schema / properties / payload / $defs / rulesets_RuleId / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RuleLogging / $ref
      Added value: +"#/$defs/rulesets_RuleLogging"
    • removedInput schema / properties / payload / $defs / rulesets_RuleLogging / description
      Removed value: -"An object configuring the rule's logging behavior."
    • removedInput schema / properties / payload / $defs / rulesets_RuleLogging / properties
      Removed value: -{
      -  "enabled": {
      -    "description": "Whether to generate a log when the rule matches.",
      -    "title": "Enabled",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RuleLogging / required
      Removed value: -[
      -  "enabled"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_RuleLogging / title
      Removed value: -"Logging"
    • removedInput schema / properties / payload / $defs / rulesets_RuleLogging / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RuleRatelimit / $ref
      Added value: +"#/$defs/rulesets_RuleRatelimit"
    • removedInput schema / properties / payload / $defs / rulesets_RuleRatelimit / description
      Removed value: -"An object configuring the rule's rate limit behavior."
    • removedInput schema / properties / payload / $defs / rulesets_RuleRatelimit / properties
      Removed value: -{
      -  "characteristics": {
      -    "description": "Characteristics of the request on which the rate limit counter will be incremented.",
      -    "items": {
      -      "description": "The characteristic of the request.",
      -      "minLength": 1,
      -      "title": "Characteristic",
      -      "type": "string"
      -    },
      -    "minItems": 1,
      -    "title": "Characteristics",
      -    "type": "array",
      -    "uniqueItems": true
      -  },
      -  "counting_expression": {
      -    "description": "An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.",
      -    "minLength": 1,
      -    "title": "Counting Expression",
      -    "type": "string"
      -  },
      -  "mitigation_timeout": {
      -    "description": "Period of time in seconds after which the action will be disabled following its first execution.",
      -    "title": "Mitigation Timeout",
      -    "type": "integer"
      -  },
      -  "period": {
      -    "description": "Period in seconds over which the counter is being incremented.",
      -    "minimum": 0,
      -    "title": "Period",
      -    "type": "integer"
      -  },
      -  "requests_per_period": {
      -    "description": "The threshold of requests per period after which the action will be executed for the first time.",
      -    "minimum": 1,
      -    "title": "Requests per Period",
      -    "type": "integer"
      -  },
      -  "requests_to_origin": {
      -    "default": false,
      -    "description": "Whether counting is only performed when an origin is reached.",
      -    "title": "Requests to Origin",
      -    "type": "boolean"
      -  },
      -  "score_per_period": {
      -    "description": "The score threshold per period for which the action will be executed the first time.",
      -    "title": "Score per Period",
      -    "type": "integer"
      -  },
      -  "score_response_header_name": {
      -    "description": "A response header name provided by the origin, which contains the score to increment rate limit counter with.",
      -    "minLength": 1,
      -    "title": "Score Response Header Name",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_RuleRatelimit / required
      Removed value: -[
      -  "characteristics",
      -  "period"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_RuleRatelimit / title
      Removed value: -"Rate Limit"
    • removedInput schema / properties / payload / $defs / rulesets_RuleRatelimit / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_Ruleset / $ref
      Added value: +"#/$defs/rulesets_Ruleset"
    • removedInput schema / properties / payload / $defs / rulesets_Ruleset / description
      Removed value: -"A ruleset object."
    • removedInput schema / properties / payload / $defs / rulesets_Ruleset / properties
      Removed value: -{
      -  "description": {
      -    "default": "",
      -    "description": "An informative description of the ruleset.",
      -    "title": "Description",
      -    "type": "string"
      -  },
      -  "id": {
      -    "allOf": [
      -      {
      -        "$ref": "#/$defs/rulesets_RulesetId"
      -      },
      -      {
      -        "type": "string"
      -      }
      -    ]
      -  },
      -  "last_updated": {
      -    "description": "The timestamp of when the ruleset was last modified.",
      -    "format": "date-time",
      -    "title": "Last Updated",
      -    "type": "string"
      -  },
      -  "name": {
      -    "description": "The human-readable name of the ruleset.",
      -    "minLength": 1,
      -    "title": "Name",
      -    "type": "string"
      -  },
      -  "version": {
      -    "allOf": [
      -      {
      -        "$ref": "#/$defs/rulesets_RulesetVersion"
      -      },
      -      {
      -        "type": "string"
      -      }
      -    ]
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_Ruleset / required
      Removed value: -[
      -  "id",
      -  "version",
      -  "last_updated"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_Ruleset / title
      Removed value: -"Ruleset"
    • removedInput schema / properties / payload / $defs / rulesets_Ruleset / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_RulesetId / $ref
      Added value: +"#/$defs/rulesets_RulesetId"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetId / description
      Removed value: -"The unique ID of the ruleset."
    • removedInput schema / properties / payload / $defs / rulesets_RulesetId / pattern
      Removed value: -"^[0-9a-f]{32}$"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetId / title
      Removed value: -"Ruleset ID"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetId / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RulesetKind / $ref
      Added value: +"#/$defs/rulesets_RulesetKind"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetKind / description
      Removed value: -"The kind of the ruleset."
    • removedInput schema / properties / payload / $defs / rulesets_RulesetKind / enum
      Removed value: -[
      -  "managed",
      -  "custom",
      -  "root",
      -  "zone"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_RulesetKind / title
      Removed value: -"Kind"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetKind / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RulesetPhase / $ref
      Added value: +"#/$defs/rulesets_RulesetPhase"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetPhase / description
      Removed value: -"The phase of the ruleset."
    • removedInput schema / properties / payload / $defs / rulesets_RulesetPhase / enum
      Removed value: -[
      -  "ddos_l4",
      -  "ddos_l7",
      -  "http_config_settings",
      -  "http_custom_errors",
      -  "http_log_custom_fields",
      -  "http_ratelimit",
      -  "http_request_cache_settings",
      -  "http_request_dynamic_redirect",
      -  "http_request_firewall_custom",
      -  "http_request_firewall_managed",
      -  "http_request_late_transform",
      -  "http_request_origin",
      -  "http_request_redirect",
      -  "http_request_sanitize",
      -  "http_request_sbfm",
      -  "http_request_transform",
      -  "http_response_cache_settings",
      -  "http_response_compression",
      -  "http_response_firewall_managed",
      -  "http_response_headers_transform",
      -  "magic_transit",
      -  "magic_transit_ids_managed",
      -  "magic_transit_managed",
      -  "magic_transit_ratelimit"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_RulesetPhase / title
      Removed value: -"Phase"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetPhase / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_RulesetVersion / $ref
      Added value: +"#/$defs/rulesets_RulesetVersion"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetVersion / description
      Removed value: -"The version of the ruleset."
    • removedInput schema / properties / payload / $defs / rulesets_RulesetVersion / pattern
      Removed value: -"^[0-9]+$"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetVersion / title
      Removed value: -"Version"
    • removedInput schema / properties / payload / $defs / rulesets_RulesetVersion / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_ScoreIncrement / $ref
      Added value: +"#/$defs/rulesets_ScoreIncrement"
    • removedInput schema / properties / payload / $defs / rulesets_ScoreIncrement / description
      Removed value: -"A delta to change the score by, which can be either positive or negative."
    • removedInput schema / properties / payload / $defs / rulesets_ScoreIncrement / title
      Removed value: -"Increment"
    • removedInput schema / properties / payload / $defs / rulesets_ScoreIncrement / type
      Removed value: -"integer"
    • addedInput schema / properties / payload / $defs / rulesets_ScoreRule / $ref
      Added value: +"#/$defs/rulesets_ScoreRule"
    • removedInput schema / properties / payload / $defs / rulesets_ScoreRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "score"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "properties": {
      -          "increment": {
      -            "$ref": "#/$defs/rulesets_ScoreIncrement"
      -          }
      -        },
      -        "required": [
      -          "increment"
      -        ],
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Score Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_ServeErrorAssetName / $ref
      Added value: +"#/$defs/rulesets_ServeErrorAssetName"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorAssetName / description
      Removed value: -"The name of a custom asset to serve as the error response."
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorAssetName / minLength
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorAssetName / title
      Removed value: -"Asset Name"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorAssetName / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_ServeErrorContent / $ref
      Added value: +"#/$defs/rulesets_ServeErrorContent"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorContent / description
      Removed value: -"The response content."
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorContent / minLength
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorContent / title
      Removed value: -"Content"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorContent / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_ServeErrorContentType / $ref
      Added value: +"#/$defs/rulesets_ServeErrorContentType"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorContentType / description
      Removed value: -"The content type header to set with the error response."
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorContentType / enum
      Removed value: -[
      -  "application/json",
      -  "text/html",
      -  "text/plain",
      -  "text/xml"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorContentType / title
      Removed value: -"Content Type"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorContentType / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_ServeErrorRule / $ref
      Added value: +"#/$defs/rulesets_ServeErrorRule"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "serve_error"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "allOf": [
      -          {
      -            "properties": {
      -              "content_type": {
      -                "$ref": "#/$defs/rulesets_ServeErrorContentType"
      -              },
      -              "status_code": {
      -                "$ref": "#/$defs/rulesets_ServeErrorStatusCode"
      -              }
      -            },
      -            "required": [
      -              "content_type"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "oneOf": [
      -              {
      -                "properties": {
      -                  "content": {
      -                    "$ref": "#/$defs/rulesets_ServeErrorContent"
      -                  }
      -                },
      -                "required": [
      -                  "content"
      -                ],
      -                "title": "Action Parameters (Content)",
      -                "type": "object"
      -              },
      -              {
      -                "properties": {
      -                  "asset_name": {
      -                    "$ref": "#/$defs/rulesets_ServeErrorAssetName"
      -                  }
      -                },
      -                "required": [
      -                  "asset_name"
      -                ],
      -                "title": "Action Parameters (Asset)",
      -                "type": "object"
      -              }
      -            ]
      -          }
      -        ]
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Serve Error Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / $ref
      Added value: +"#/$defs/rulesets_ServeErrorStatusCode"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / description
      Removed value: -"The status code to use for the error."
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / maximum
      Removed value: -999
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / minimum
      Removed value: -400
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / title
      Removed value: -"Status Code"
    • removedInput schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / type
      Removed value: -"integer"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / $ref
      Added value: +"#/$defs/rulesets_SetCacheControlCloudflareOnly"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / default
      Removed value: -false
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / description
      Removed value: -"Whether the directive should only be applied to the Cloudflare CDN cache."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / title
      Removed value: -"Cloudflare Only"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirective / $ref
      Added value: +"#/$defs/rulesets_SetCacheControlDirective"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirective / description
      Removed value: -"A cache-control directive configuration."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirective / oneOf
      Removed value: -[
      -  {
      -    "description": "Set the directive.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "set"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Set Directive",
      -    "type": "object"
      -  },
      -  {
      -    "description": "Remove the directive.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "remove"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Remove Directive",
      -    "type": "object"
      -  }
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirective / title
      Removed value: -"Cache Control Directive"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / $ref
      Added value: +"#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / description
      Removed value: -"A cache-control directive configuration that accepts optional qualifiers (header names)."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / oneOf
      Removed value: -[
      -  {
      -    "description": "Set the directive with optional qualifiers.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "set"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      },
      -      "qualifiers": {
      -        "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).",
      -        "items": {
      -          "description": "A header name to qualify the directive.",
      -          "minLength": 1,
      -          "title": "Qualifier",
      -          "type": "string"
      -        },
      -        "title": "Qualifiers",
      -        "type": "array",
      -        "uniqueItems": true
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Set Directive",
      -    "type": "object"
      -  },
      -  {
      -    "description": "Remove the directive.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "remove"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Remove Directive",
      -    "type": "object"
      -  }
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / title
      Removed value: -"Cache Control Directive With Optional Qualifiers"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / $ref
      Added value: +"#/$defs/rulesets_SetCacheControlDirectiveWithValue"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / description
      Removed value: -"A cache-control directive configuration that accepts a duration value in seconds."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / oneOf
      Removed value: -[
      -  {
      -    "description": "Set the directive with a duration value in seconds.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "set"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      },
      -      "value": {
      -        "description": "The duration value in seconds for the directive.",
      -        "minimum": 0,
      -        "title": "Value",
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "value"
      -    ],
      -    "title": "Set Directive",
      -    "type": "object"
      -  },
      -  {
      -    "description": "Remove the directive.",
      -    "properties": {
      -      "cloudflare_only": {
      -        "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly"
      -      },
      -      "operation": {
      -        "allOf": [
      -          {
      -            "$ref": "#/$defs/rulesets_SetCacheControlOperation"
      -          },
      -          {
      -            "enum": [
      -              "remove"
      -            ],
      -            "type": "string"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "operation"
      -    ],
      -    "title": "Remove Directive",
      -    "type": "object"
      -  }
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / title
      Removed value: -"Cache Control Directive With Duration Seconds Value"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheControlOperation / $ref
      Added value: +"#/$defs/rulesets_SetCacheControlOperation"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlOperation / description
      Removed value: -"The operation to perform on the cache-control directive."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlOperation / enum
      Removed value: -[
      -  "set",
      -  "remove"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlOperation / title
      Removed value: -"Operation"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlOperation / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheControlRule / $ref
      Added value: +"#/$defs/rulesets_SetCacheControlRule"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheControlRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "set_cache_control"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "minProperties": 1,
      -        "properties": {
      -          "immutable": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirective"
      -          },
      -          "max-age": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue"
      -          },
      -          "must-revalidate": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirective"
      -          },
      -          "must-understand": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirective"
      -          },
      -          "no-cache": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers"
      -          },
      -          "no-store": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirective"
      -          },
      -          "no-transform": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirective"
      -          },
      -          "private": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers"
      -          },
      -          "proxy-revalidate": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirective"
      -          },
      -          "public": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirective"
      -          },
      -          "s-maxage": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue"
      -          },
      -          "stale-if-error": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue"
      -          },
      -          "stale-while-revalidate": {
      -            "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Set Cache Control Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsAdditionalCacheablePorts"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / description
      Removed value: -"A list of additional ports that caching should be enabled on."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / items
      Removed value: -{
      -  "description": "A port to enable caching on.",
      -  "maximum": 65535,
      -  "minimum": 1,
      -  "title": "Additional Cacheable Port",
      -  "type": "integer"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / title
      Removed value: -"Additional Cacheable Ports (Enterprise-Only)"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / type
      Removed value: -"array"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / uniqueItems
      Removed value: -true
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsBrowserTTL"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / description
      Removed value: -"How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / properties
      Removed value: -{
      -  "default": {
      -    "description": "The browser TTL (in seconds) if you choose the \"override_origin\" mode.",
      -    "minimum": 0,
      -    "title": "Default TTL",
      -    "type": "integer"
      -  },
      -  "mode": {
      -    "description": "The browser TTL mode.",
      -    "enum": [
      -      "respect_origin",
      -      "bypass_by_default",
      -      "override_origin",
      -      "bypass"
      -    ],
      -    "title": "TTL Mode",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / required
      Removed value: -[
      -  "mode"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / title
      Removed value: -"Browser TTL"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCache"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / description
      Removed value: -"Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / title
      Removed value: -"Cache"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCacheKey"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / description
      Removed value: -"Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / properties
      Removed value: -{
      -  "cache_by_device_type": {
      -    "description": "Whether to separate cached content based on the visitor's device type.",
      -    "title": "Cache by Device Type",
      -    "type": "boolean"
      -  },
      -  "cache_deception_armor": {
      -    "description": "Whether to protect from web cache deception attacks, while allowing static assets to be cached.",
      -    "title": "Cache Deception Armor",
      -    "type": "boolean"
      -  },
      -  "custom_key": {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKey"
      -  },
      -  "ignore_query_strings_order": {
      -    "description": "Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.",
      -    "title": "Ignore Query Strings Order",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / title
      Removed value: -"Cache Key"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCacheReserve"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / description
      Removed value: -"Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan)."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / properties
      Removed value: -{
      -  "eligible": {
      -    "description": "Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.",
      -    "title": "Eligible",
      -    "type": "boolean"
      -  },
      -  "minimum_file_size": {
      -    "description": "The minimum file size eligible for storage in Cache Reserve.",
      -    "minimum": 0,
      -    "title": "Minimum File Size",
      -    "type": "integer"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / required
      Removed value: -[
      -  "eligible"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / title
      Removed value: -"Cache Reserve"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKey"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / description
      Removed value: -"Which components of the request are included or excluded from the cache key."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / properties
      Removed value: -{
      -  "cookie": {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyCookie"
      -  },
      -  "header": {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHeader"
      -  },
      -  "host": {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHost"
      -  },
      -  "query_string": {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyQueryString"
      -  },
      -  "user": {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyUser"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / title
      Removed value: -"Custom Cache Key"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyCookie"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / description
      Removed value: -"Which cookies to include in the cache key."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / properties
      Removed value: -{
      -  "check_presence": {
      -    "description": "A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.",
      -    "items": {
      -      "description": "The name of the cookie to check for the presence of.",
      -      "minLength": 1,
      -      "title": "Cookie Name",
      -      "type": "string"
      -    },
      -    "minItems": 1,
      -    "title": "Check Presence",
      -    "type": "array",
      -    "uniqueItems": true
      -  },
      -  "include": {
      -    "description": "A list of cookies to include in the cache key.",
      -    "items": {
      -      "description": "The name of the cookie to include.",
      -      "minLength": 1,
      -      "title": "Cookie Name",
      -      "type": "string"
      -    },
      -    "minItems": 1,
      -    "title": "Include",
      -    "type": "array",
      -    "uniqueItems": true
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / title
      Removed value: -"Cookies"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHeader"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / description
      Removed value: -"Which headers to include in the cache key."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / properties
      Removed value: -{
      -  "check_presence": {
      -    "description": "A list of headers to check for the presence of. The presence of these headers is included in the cache key.",
      -    "items": {
      -      "description": "The name of the header to check for the presence of.",
      -      "minLength": 1,
      -      "title": "Header",
      -      "type": "string"
      -    },
      -    "minItems": 1,
      -    "title": "Check Presence",
      -    "type": "array",
      -    "uniqueItems": true
      -  },
      -  "contains": {
      -    "additionalProperties": {
      -      "description": "A list of values to match the header against.",
      -      "items": {
      -        "description": "The header value to match against.",
      -        "minLength": 1,
      -        "title": "Header Value",
      -        "type": "string"
      -      },
      -      "minItems": 1,
      -      "title": "Header Values",
      -      "type": "array",
      -      "uniqueItems": true
      -    },
      -    "description": "A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.",
      -    "minProperties": 1,
      -    "title": "Contains",
      -    "type": "object"
      -  },
      -  "exclude_origin": {
      -    "description": "Whether to exclude the origin header in the cache key.",
      -    "title": "Exclude Origin",
      -    "type": "boolean"
      -  },
      -  "include": {
      -    "description": "A list of headers to include in the cache key.",
      -    "items": {
      -      "description": "The name of the header to include.",
      -      "minLength": 1,
      -      "title": "Header",
      -      "type": "string"
      -    },
      -    "minItems": 1,
      -    "title": "Include",
      -    "type": "array",
      -    "uniqueItems": true
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / title
      Removed value: -"Headers"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHost"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / description
      Removed value: -"How to use the host in the cache key."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / properties
      Removed value: -{
      -  "resolved": {
      -    "description": "Whether to use the resolved host in the cache key.",
      -    "title": "Use Resolved Host",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / title
      Removed value: -"Host"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyQueryString"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / description
      Removed value: -"Which query string parameters to include in or exclude from the cache key."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / maxProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / properties
      Removed value: -{
      -  "exclude": {
      -    "description": "Which query string parameters to exclude from the cache key.",
      -    "maxProperties": 1,
      -    "minProperties": 1,
      -    "properties": {
      -      "all": {
      -        "description": "Whether to exclude all query string parameters from the cache key.",
      -        "enum": [
      -          true
      -        ],
      -        "title": "Exclude All",
      -        "type": "boolean"
      -      },
      -      "list": {
      -        "description": "A list of query string parameters to exclude from the cache key.",
      -        "items": {
      -          "description": "The name of the query string parameter to exclude.",
      -          "minLength": 1,
      -          "title": "Parameter Name",
      -          "type": "string"
      -        },
      -        "minItems": 1,
      -        "title": "Exclude List",
      -        "type": "array",
      -        "uniqueItems": true
      -      }
      -    },
      -    "title": "Exclude",
      -    "type": "object"
      -  },
      -  "include": {
      -    "description": "Which query string parameters to include in the cache key.",
      -    "maxProperties": 1,
      -    "minProperties": 1,
      -    "properties": {
      -      "all": {
      -        "description": "Whether to include all query string parameters in the cache key.",
      -        "enum": [
      -          true
      -        ],
      -        "title": "Include All",
      -        "type": "boolean"
      -      },
      -      "list": {
      -        "description": "A list of query string parameters to include in the cache key.",
      -        "items": {
      -          "description": "The name of the query string parameter to include.",
      -          "minLength": 1,
      -          "title": "Parameter Name",
      -          "type": "string"
      -        },
      -        "minItems": 1,
      -        "title": "Include List",
      -        "type": "array",
      -        "uniqueItems": true
      -      }
      -    },
      -    "title": "Include",
      -    "type": "object"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / title
      Removed value: -"Query String Parameters"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyUser"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / description
      Removed value: -"How to use characteristics of the request user agent in the cache key."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / properties
      Removed value: -{
      -  "device_type": {
      -    "description": "Whether to use the user agent's device type in the cache key.",
      -    "title": "Device Type",
      -    "type": "boolean"
      -  },
      -  "geo": {
      -    "description": "Whether to use the user agents's country in the cache key.",
      -    "title": "Country",
      -    "type": "boolean"
      -  },
      -  "lang": {
      -    "description": "Whether to use the user agent's language in the cache key.",
      -    "title": "Language",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / title
      Removed value: -"User"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsEdgeTTL"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / description
      Removed value: -"How long the Cloudflare edge network should cache the response."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / properties
      Removed value: -{
      -  "default": {
      -    "description": "The edge TTL (in seconds) if you choose the \"override_origin\" mode.",
      -    "minimum": 0,
      -    "title": "Default TTL",
      -    "type": "integer"
      -  },
      -  "mode": {
      -    "description": "The edge TTL mode.",
      -    "enum": [
      -      "respect_origin",
      -      "bypass_by_default",
      -      "override_origin"
      -    ],
      -    "title": "TTL Mode",
      -    "type": "string"
      -  },
      -  "status_code_ttl": {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsStatusCodeTTL"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / required
      Removed value: -[
      -  "mode"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / title
      Removed value: -"Edge TTL"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsOriginCacheControl"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / description
      Removed value: -"Whether Cloudflare will aim to strictly adhere to RFC 7234."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / title
      Removed value: -"Origin Cache Control (Enterprise-Only)"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsOriginErrorPagePassthru"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / description
      Removed value: -"Whether to generate Cloudflare error pages for issues from the origin server."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / title
      Removed value: -"Origin Error Page Passthrough"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsOriginRangeRequests"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / description
      Removed value: -"Controls whether Cloudflare fetches a large asset from the origin as a series of range requests instead of one whole-body request."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / properties
      Removed value: -{
      -  "mode": {
      -    "description": "Whether to use range requests. `default` is the behaviour the zone gets without this rule.",
      -    "enum": [
      -      "on",
      -      "off",
      -      "default"
      -    ],
      -    "title": "Mode",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / required
      Removed value: -[
      -  "mode"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / title
      Removed value: -"Origin Range Requests"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsReadTimeout"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / description
      Removed value: -"A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / maximum
      Removed value: -6000
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / minimum
      Removed value: -100
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / title
      Removed value: -"Read Timeout (Enterprise-Only)"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / type
      Removed value: -"integer"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsRespectStrongEtags"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / description
      Removed value: -"Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / title
      Removed value: -"Respect Strong ETags"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsRule / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsRule"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "set_cache_settings"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "minProperties": 1,
      -        "properties": {
      -          "additional_cacheable_ports": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsAdditionalCacheablePorts"
      -          },
      -          "browser_ttl": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsBrowserTTL"
      -          },
      -          "cache": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsCache"
      -          },
      -          "cache_key": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsCacheKey"
      -          },
      -          "cache_reserve": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsCacheReserve"
      -          },
      -          "edge_ttl": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsEdgeTTL"
      -          },
      -          "origin_cache_control": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsOriginCacheControl"
      -          },
      -          "origin_error_page_passthru": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsOriginErrorPagePassthru"
      -          },
      -          "origin_range_requests": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsOriginRangeRequests"
      -          },
      -          "read_timeout": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsReadTimeout"
      -          },
      -          "respect_strong_etags": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsRespectStrongEtags"
      -          },
      -          "serve_stale": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsServeStale"
      -          },
      -          "shared_dictionary": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsSharedDictionary"
      -          },
      -          "strip_etags": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsStripETags"
      -          },
      -          "strip_last_modified": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsStripLastModified"
      -          },
      -          "strip_set_cookie": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsStripSetCookie"
      -          },
      -          "vary": {
      -            "$ref": "#/$defs/rulesets_SetCacheSettingsVary"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Set Cache Settings Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsServeStale"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / description
      Removed value: -"When to serve stale content from cache."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / properties
      Removed value: -{
      -  "disable_stale_while_updating": {
      -    "description": "Whether Cloudflare should disable serving stale content while getting the latest content from the origin.",
      -    "title": "Disable Stale While Updating",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / title
      Removed value: -"Serve Stale"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsSharedDictionary"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / description
      Removed value: -"Configuration for shared dictionary compression. When set, Cloudflare injects Use-As-Dictionary headers on matching cacheable responses."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / properties
      Removed value: -{
      -  "match_pattern": {
      -    "description": "URL pattern for the Use-As-Dictionary match field. This pattern specifies which URLs can use this response as a dictionary.",
      -    "maxLength": 1024,
      -    "minLength": 1,
      -    "title": "Match Pattern",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / required
      Removed value: -[
      -  "match_pattern"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / title
      Removed value: -"Shared Dictionary"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsStatusCodeTTL"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / description
      Removed value: -"A list of TTLs to apply to specific status codes or status code ranges."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / items
      Removed value: -{
      -  "maxProperties": 2,
      -  "minProperties": 2,
      -  "properties": {
      -    "status_code": {
      -      "description": "A single status code to apply the TTL to.",
      -      "maximum": 999,
      -      "minimum": 100,
      -      "title": "Status Code",
      -      "type": "integer"
      -    },
      -    "status_code_range": {
      -      "description": "A range of status codes to apply the TTL to.",
      -      "minProperties": 1,
      -      "properties": {
      -        "from": {
      -          "description": "The lower bound of the range.",
      -          "maximum": 999,
      -          "minimum": 100,
      -          "title": "From",
      -          "type": "integer"
      -        },
      -        "to": {
      -          "description": "The upper bound of the range.",
      -          "maximum": 999,
      -          "minimum": 100,
      -          "title": "To",
      -          "type": "integer"
      -        }
      -      },
      -      "title": "Status Code Range",
      -      "type": "object"
      -    },
      -    "value": {
      -      "description": "The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value \"no-cache\". A value of -1 is equivalent to setting the cache control header with the value of \"no-store\".",
      -      "title": "TTL Value",
      -      "type": "integer"
      -    }
      -  },
      -  "required": [
      -    "value"
      -  ],
      -  "type": "object"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / title
      Removed value: -"Status Code TTLs"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / type
      Removed value: -"array"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / uniqueItems
      Removed value: -true
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsStripETags"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / description
      Removed value: -"Whether to strip ETag headers from the origin response before caching."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / title
      Removed value: -"Strip ETags"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsStripLastModified"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / description
      Removed value: -"Whether to strip Last-Modified headers from the origin response before caching."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / title
      Removed value: -"Strip Last-Modified"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsStripSetCookie"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / description
      Removed value: -"Whether to strip Set-Cookie headers from the origin response before caching."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / title
      Removed value: -"Strip Set-Cookie"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsVary"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / description
      Removed value: -"Controls how cached responses vary based on request headers. `default` is required by the API and applies to any Vary response header that does not have a per-header override."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / minProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / properties
      Removed value: -{
      -  "default": {
      -    "$ref": "#/$defs/rulesets_SetCacheSettingsVaryDefault"
      -  },
      -  "headers": {
      -    "additionalProperties": {
      -      "$ref": "#/$defs/rulesets_SetCacheSettingsVaryHeader"
      -    },
      -    "description": "A mapping of lowercase request header names to their vary configuration.",
      -    "maxProperties": 50,
      -    "title": "Headers",
      -    "type": "object"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / title
      Removed value: -"Vary"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsVaryDefault"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / description
      Removed value: -"Controls how response Vary headers without a per-header override contribute to the cache key."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / properties
      Removed value: -{
      -  "action": {
      -    "description": "How the header value is treated when building the cache key.",
      -    "enum": [
      -      "bypass",
      -      "passthrough",
      -      "normalize"
      -    ],
      -    "title": "Action",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / required
      Removed value: -[
      -  "action"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / title
      Removed value: -"Vary Default"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / $ref
      Added value: +"#/$defs/rulesets_SetCacheSettingsVaryHeader"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / description
      Removed value: -"Controls how a single request header contributes to the cache key."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / properties
      Removed value: -{
      -  "action": {
      -    "description": "How the header value is treated when building the cache key.",
      -    "enum": [
      -      "bypass",
      -      "passthrough",
      -      "normalize"
      -    ],
      -    "title": "Action",
      -    "type": "string"
      -  },
      -  "languages": {
      -    "description": "The set of languages to normalize against. Only valid for the `accept-language` header.",
      -    "items": {
      -      "description": "A language tag to normalize against. Must be printable ASCII.",
      -      "maxLength": 64,
      -      "minLength": 1,
      -      "pattern": "^[ -~]+$",
      -      "title": "Language",
      -      "type": "string"
      -    },
      -    "maxItems": 20,
      -    "title": "Languages",
      -    "type": "array"
      -  },
      -  "media_types": {
      -    "description": "The set of media types to normalize against. Only valid for the `accept` header.",
      -    "items": {
      -      "description": "A media type to normalize against. Must be printable ASCII.",
      -      "maxLength": 255,
      -      "minLength": 1,
      -      "pattern": "^[ -~]+$",
      -      "title": "Media Type",
      -      "type": "string"
      -    },
      -    "maxItems": 10,
      -    "title": "Media Types",
      -    "type": "array"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / required
      Removed value: -[
      -  "action"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / title
      Removed value: -"Vary Header"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / $ref
      Added value: +"#/$defs/rulesets_SetCacheTagsExpression"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / description
      Removed value: -"An expression that evaluates to an array of cache tag values."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / minLength
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / title
      Removed value: -"Expression"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / $ref
      Added value: +"#/$defs/rulesets_SetCacheTagsOperation"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / description
      Removed value: -"The operation to perform on the cache tags."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / enum
      Removed value: -[
      -  "add",
      -  "remove",
      -  "set"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / title
      Removed value: -"Operation"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheTagsRule / $ref
      Added value: +"#/$defs/rulesets_SetCacheTagsRule"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "set_cache_tags"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "oneOf": [
      -          {
      -            "description": "Add cache tags using a list of values.",
      -            "properties": {
      -              "operation": {
      -                "allOf": [
      -                  {
      -                    "$ref": "#/$defs/rulesets_SetCacheTagsOperation"
      -                  },
      -                  {
      -                    "enum": [
      -                      "add"
      -                    ],
      -                    "type": "string"
      -                  }
      -                ]
      -              },
      -              "values": {
      -                "$ref": "#/$defs/rulesets_SetCacheTagsValues"
      -              }
      -            },
      -            "required": [
      -              "operation",
      -              "values"
      -            ],
      -            "title": "Add Cache Tags (Values)",
      -            "type": "object"
      -          },
      -          {
      -            "description": "Add cache tags using an expression.",
      -            "properties": {
      -              "expression": {
      -                "$ref": "#/$defs/rulesets_SetCacheTagsExpression"
      -              },
      -              "operation": {
      -                "allOf": [
      -                  {
      -                    "$ref": "#/$defs/rulesets_SetCacheTagsOperation"
      -                  },
      -                  {
      -                    "enum": [
      -                      "add"
      -                    ],
      -                    "type": "string"
      -                  }
      -                ]
      -              }
      -            },
      -            "required": [
      -              "operation",
      -              "expression"
      -            ],
      -            "title": "Add Cache Tags (Expression)",
      -            "type": "object"
      -          },
      -          {
      -            "description": "Remove cache tags using a list of values.",
      -            "properties": {
      -              "operation": {
      -                "allOf": [
      -                  {
      -                    "$ref": "#/$defs/rulesets_SetCacheTagsOperation"
      -                  },
      -                  {
      -                    "enum": [
      -                      "remove"
      -                    ],
      -                    "type": "string"
      -                  }
      -                ]
      -              },
      -              "values": {
      -                "$ref": "#/$defs/rulesets_SetCacheTagsValues"
      -              }
      -            },
      -            "required": [
      -              "operation",
      -              "values"
      -            ],
      -            "title": "Remove Cache Tags (Values)",
      -            "type": "object"
      -          },
      -          {
      -            "description": "Remove cache tags using an expression.",
      -            "properties": {
      -              "expression": {
      -                "$ref": "#/$defs/rulesets_SetCacheTagsExpression"
      -              },
      -              "operation": {
      -                "allOf": [
      -                  {
      -                    "$ref": "#/$defs/rulesets_SetCacheTagsOperation"
      -                  },
      -                  {
      -                    "enum": [
      -                      "remove"
      -                    ],
      -                    "type": "string"
      -                  }
      -                ]
      -              }
      -            },
      -            "required": [
      -              "operation",
      -              "expression"
      -            ],
      -            "title": "Remove Cache Tags (Expression)",
      -            "type": "object"
      -          },
      -          {
      -            "description": "Set cache tags using a list of values.",
      -            "properties": {
      -              "operation": {
      -                "allOf": [
      -                  {
      -                    "$ref": "#/$defs/rulesets_SetCacheTagsOperation"
      -                  },
      -                  {
      -                    "enum": [
      -                      "set"
      -                    ],
      -                    "type": "string"
      -                  }
      -                ]
      -              },
      -              "values": {
      -                "$ref": "#/$defs/rulesets_SetCacheTagsValues"
      -              }
      -            },
      -            "required": [
      -              "operation",
      -              "values"
      -            ],
      -            "title": "Set Cache Tags (Values)",
      -            "type": "object"
      -          },
      -          {
      -            "description": "Set cache tags using an expression.",
      -            "properties": {
      -              "expression": {
      -                "$ref": "#/$defs/rulesets_SetCacheTagsExpression"
      -              },
      -              "operation": {
      -                "allOf": [
      -                  {
      -                    "$ref": "#/$defs/rulesets_SetCacheTagsOperation"
      -                  },
      -                  {
      -                    "enum": [
      -                      "set"
      -                    ],
      -                    "type": "string"
      -                  }
      -                ]
      -              }
      -            },
      -            "required": [
      -              "operation",
      -              "expression"
      -            ],
      -            "title": "Set Cache Tags (Expression)",
      -            "type": "object"
      -          }
      -        ]
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Set Cache Tags Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_SetCacheTagsValues / $ref
      Added value: +"#/$defs/rulesets_SetCacheTagsValues"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsValues / description
      Removed value: -"A list of cache tag values."
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsValues / items
      Removed value: -{
      -  "description": "A cache tag value.",
      -  "minLength": 1,
      -  "title": "Cache Tag",
      -  "type": "string"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsValues / maxItems
      Removed value: -100
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsValues / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsValues / title
      Removed value: -"Values"
    • removedInput schema / properties / payload / $defs / rulesets_SetCacheTagsValues / type
      Removed value: -"array"
    • addedInput schema / properties / payload / $defs / rulesets_SetConfigAutominify / $ref
      Added value: +"#/$defs/rulesets_SetConfigAutominify"
    • removedInput schema / properties / payload / $defs / rulesets_SetConfigAutominify / description
      Removed value: -"Which file extensions to minify automatically."
    • removedInput schema / properties / payload / $defs / rulesets_SetConfigAutominify / properties
      Removed value: -{
      -  "css": {
      -    "default": false,
      -    "description": "Whether to minify CSS files.",
      -    "title": "CSS",
      -    "type": "boolean"
      -  },
      -  "html": {
      -    "default": false,
      -    "description": "Whether to minify HTML files.",
      -    "title": "HTML",
      -    "type": "boolean"
      -  },
      -  "js": {
      -    "default": false,
      -    "description": "Whether to minify JavaScript files.",
      -    "title": "JavaScript",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SetConfigAutominify / title
      Removed value: -"Auto-Minify"
    • removedInput schema / properties / payload / $defs / rulesets_SetConfigAutominify / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SetConfigRule / $ref
      Added value: +"#/$defs/rulesets_SetConfigRule"
    • removedInput schema / properties / payload / $defs / rulesets_SetConfigRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "set_config"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "minProperties": 1,
      -        "properties": {
      -          "automatic_https_rewrites": {
      -            "description": "Whether to enable Automatic HTTPS Rewrites.",
      -            "title": "Automatic HTTPS Rewrites",
      -            "type": "boolean"
      -          },
      -          "autominify": {
      -            "$ref": "#/$defs/rulesets_SetConfigAutominify"
      -          },
      -          "bic": {
      -            "description": "Whether to enable Browser Integrity Check (BIC).",
      -            "title": "Browser Integrity Check",
      -            "type": "boolean"
      -          },
      -          "content_converter": {
      -            "description": "Whether to enable content conversion (e.g., HTML to Markdown).",
      -            "title": "Content Converter",
      -            "type": "boolean"
      -          },
      -          "disable_apps": {
      -            "deprecated": true,
      -            "description": "Whether to disable Cloudflare Apps.",
      -            "enum": [
      -              true
      -            ],
      -            "title": "Disable Apps",
      -            "type": "boolean"
      -          },
      -          "disable_pay_per_crawl": {
      -            "description": "Whether to disable Pay Per Crawl.",
      -            "enum": [
      -              true
      -            ],
      -            "title": "Disable Pay Per Crawl",
      -            "type": "boolean"
      -          },
      -          "disable_rum": {
      -            "description": "Whether to disable Real User Monitoring (RUM).",
      -            "enum": [
      -              true
      -            ],
      -            "title": "Disable RUM",
      -            "type": "boolean"
      -          },
      -          "disable_zaraz": {
      -            "description": "Whether to disable Zaraz.",
      -            "enum": [
      -              true
      -            ],
      -            "title": "Disable Zaraz",
      -            "type": "boolean"
      -          },
      -          "email_obfuscation": {
      -            "description": "Whether to enable Email Obfuscation.",
      -            "title": "Email Obfuscation",
      -            "type": "boolean"
      -          },
      -          "fonts": {
      -            "description": "Whether to enable Cloudflare Fonts.",
      -            "title": "Cloudflare Fonts",
      -            "type": "boolean"
      -          },
      -          "hotlink_protection": {
      -            "description": "Whether to enable Hotlink Protection.",
      -            "title": "Hotlink Protection",
      -            "type": "boolean"
      -          },
      -          "mirage": {
      -            "deprecated": true,
      -            "description": "Whether to enable Mirage.",
      -            "title": "Mirage",
      -            "type": "boolean"
      -          },
      -          "opportunistic_encryption": {
      -            "description": "Whether to enable Opportunistic Encryption.",
      -            "title": "Opportunistic Encryption",
      -            "type": "boolean"
      -          },
      -          "polish": {
      -            "description": "The Polish level to configure.",
      -            "enum": [
      -              "off",
      -              "lossless",
      -              "lossy",
      -              "webp"
      -            ],
      -            "title": "Polish",
      -            "type": "string"
      -          },
      -          "redirects_for_ai_training": {
      -            "description": "Whether to redirect verified AI training crawlers to canonical URLs found in the HTML response.",
      -            "title": "Redirects for AI Training",
      -            "type": "boolean"
      -          },
      -          "request_body_buffering": {
      -            "description": "The request body buffering mode.",
      -            "enum": [
      -              "none",
      -              "standard",
      -              "full"
      -            ],
      -            "title": "Request body buffering",
      -            "type": "string"
      -          },
      -          "response_body_buffering": {
      -            "description": "The response body buffering mode.",
      -            "enum": [
      -              "none",
      -              "standard"
      -            ],
      -            "title": "Response body buffering",
      -            "type": "string"
      -          },
      -          "rocket_loader": {
      -            "description": "Whether to enable Rocket Loader.",
      -            "title": "Rocket Loader",
      -            "type": "boolean"
      -          },
      -          "security_level": {
      -            "description": "The Security Level to configure.",
      -            "enum": [
      -              "off",
      -              "essentially_off",
      -              "low",
      -              "medium",
      -              "high",
      -              "under_attack"
      -            ],
      -            "title": "Security Level",
      -            "type": "string"
      -          },
      -          "server_side_excludes": {
      -            "description": "Whether to enable Server-Side Excludes.",
      -            "title": "Server-Side Excludes",
      -            "type": "boolean"
      -          },
      -          "ssl": {
      -            "description": "The SSL level to configure.",
      -            "enum": [
      -              "off",
      -              "flexible",
      -              "full",
      -              "strict",
      -              "origin_pull"
      -            ],
      -            "title": "SSL",
      -            "type": "string"
      -          },
      -          "sxg": {
      -            "deprecated": true,
      -            "description": "Whether to enable Signed Exchanges (SXG).",
      -            "title": "Signed Exchanges",
      -            "type": "boolean"
      -          },
      -          "webmcp_enabled": {
      -            "description": "Whether to serve the WebMCP bridge script, which exposes the page's tools to browser AI agents.",
      -            "title": "WebMCP",
      -            "type": "boolean"
      -          },
      -          "webmcp_packs": {
      -            "description": "Bundled WebMCP tool packs to activate for matching requests. An empty array disables all packs. Omitting this parameter leaves the pack selection unchanged. Does not enable the WebMCP bridge itself. Non-empty selections require the WebMCP Configuration Rules entitlement.",
      -            "items": {
      -              "description": "A tool-pack identifier understood by the WebMCP interceptor.",
      -              "maxLength": 128,
      -              "minLength": 1,
      -              "pattern": "^[A-Za-z0-9._:/@-]+$",
      -              "type": "string"
      -            },
      -            "maxItems": 100,
      -            "title": "WebMCP Tool Packs",
      -            "type": "array",
      -            "uniqueItems": true
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Set Configuration Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_SkipPhase / $ref
      Added value: +"#/$defs/rulesets_SkipPhase"
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhase / description
      Removed value: -"A phase to skip the execution of. This option is only compatible with the products option."
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhase / enum
      Removed value: -[
      -  "current"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhase / title
      Removed value: -"Phase"
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhase / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_SkipPhases / $ref
      Added value: +"#/$defs/rulesets_SkipPhases"
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhases / description
      Removed value: -"A list of phases to skip the execution of. This option is incompatible with the rulesets option."
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhases / items
      Removed value: -{
      -  "allOf": [
      -    {
      -      "$ref": "#/$defs/rulesets_RulesetPhase"
      -    },
      -    {
      -      "description": "The phase to skip the execution of.",
      -      "type": "string"
      -    }
      -  ]
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhases / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhases / title
      Removed value: -"Phases"
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhases / type
      Removed value: -"array"
    • removedInput schema / properties / payload / $defs / rulesets_SkipPhases / uniqueItems
      Removed value: -true
    • addedInput schema / properties / payload / $defs / rulesets_SkipProducts / $ref
      Added value: +"#/$defs/rulesets_SkipProducts"
    • removedInput schema / properties / payload / $defs / rulesets_SkipProducts / description
      Removed value: -"A list of legacy security products to skip the execution of."
    • removedInput schema / properties / payload / $defs / rulesets_SkipProducts / items
      Removed value: -{
      -  "description": "The name of a legacy security product to skip the execution of.",
      -  "enum": [
      -    "bic",
      -    "hot",
      -    "rateLimit",
      -    "securityLevel",
      -    "uaBlock",
      -    "waf",
      -    "zoneLockdown"
      -  ],
      -  "title": "Product",
      -  "type": "string"
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SkipProducts / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SkipProducts / title
      Removed value: -"Products"
    • removedInput schema / properties / payload / $defs / rulesets_SkipProducts / type
      Removed value: -"array"
    • removedInput schema / properties / payload / $defs / rulesets_SkipProducts / uniqueItems
      Removed value: -true
    • addedInput schema / properties / payload / $defs / rulesets_SkipRule / $ref
      Added value: +"#/$defs/rulesets_SkipRule"
    • removedInput schema / properties / payload / $defs / rulesets_SkipRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "skip"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "minProperties": 1,
      -        "properties": {
      -          "phase": {
      -            "$ref": "#/$defs/rulesets_SkipPhase"
      -          },
      -          "phases": {
      -            "$ref": "#/$defs/rulesets_SkipPhases"
      -          },
      -          "products": {
      -            "$ref": "#/$defs/rulesets_SkipProducts"
      -          },
      -          "rules": {
      -            "$ref": "#/$defs/rulesets_SkipRules"
      -          },
      -          "ruleset": {
      -            "$ref": "#/$defs/rulesets_SkipRuleset"
      -          },
      -          "rulesets": {
      -            "$ref": "#/$defs/rulesets_SkipRulesets"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Skip Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_SkipRules / $ref
      Added value: +"#/$defs/rulesets_SkipRules"
    • removedInput schema / properties / payload / $defs / rulesets_SkipRules / additionalProperties
      Removed value: -{
      -  "description": "A list of rule IDs in the ruleset to skip the execution of.",
      -  "items": {
      -    "allOf": [
      -      {
      -        "$ref": "#/$defs/rulesets_RuleId"
      -      },
      -      {
      -        "description": "The ID of a rule in the ruleset to skip the execution of.",
      -        "title": "Rule",
      -        "type": "string"
      -      }
      -    ]
      -  },
      -  "minItems": 1,
      -  "title": "Rules",
      -  "type": "array",
      -  "uniqueItems": true
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SkipRules / description
      Removed value: -"A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option."
    • removedInput schema / properties / payload / $defs / rulesets_SkipRules / minProperties
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SkipRules / title
      Removed value: -"Rules"
    • removedInput schema / properties / payload / $defs / rulesets_SkipRules / type
      Removed value: -"object"
    • addedInput schema / properties / payload / $defs / rulesets_SkipRuleset / $ref
      Added value: +"#/$defs/rulesets_SkipRuleset"
    • removedInput schema / properties / payload / $defs / rulesets_SkipRuleset / description
      Removed value: -"A ruleset to skip the execution of. This option is incompatible with the rulesets option."
    • removedInput schema / properties / payload / $defs / rulesets_SkipRuleset / enum
      Removed value: -[
      -  "current"
      -]
    • removedInput schema / properties / payload / $defs / rulesets_SkipRuleset / title
      Removed value: -"Ruleset"
    • removedInput schema / properties / payload / $defs / rulesets_SkipRuleset / type
      Removed value: -"string"
    • addedInput schema / properties / payload / $defs / rulesets_SkipRulesets / $ref
      Added value: +"#/$defs/rulesets_SkipRulesets"
    • removedInput schema / properties / payload / $defs / rulesets_SkipRulesets / description
      Removed value: -"A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options."
    • removedInput schema / properties / payload / $defs / rulesets_SkipRulesets / items
      Removed value: -{
      -  "allOf": [
      -    {
      -      "$ref": "#/$defs/rulesets_RulesetId"
      -    },
      -    {
      -      "description": "The ID of a ruleset to skip the execution of.",
      -      "title": "Ruleset",
      -      "type": "string"
      -    }
      -  ]
      -}
    • removedInput schema / properties / payload / $defs / rulesets_SkipRulesets / minItems
      Removed value: -1
    • removedInput schema / properties / payload / $defs / rulesets_SkipRulesets / title
      Removed value: -"Rulesets"
    • removedInput schema / properties / payload / $defs / rulesets_SkipRulesets / type
      Removed value: -"array"
    • removedInput schema / properties / payload / $defs / rulesets_SkipRulesets / uniqueItems
      Removed value: -true
    • addedInput schema / properties / payload / $defs / rulesets_TransformResponseHTMLRule / $ref
      Added value: +"#/$defs/rulesets_TransformResponseHTMLRule"
    • removedInput schema / properties / payload / $defs / rulesets_TransformResponseHTMLRule / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/rulesets_Rule"
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "enum": [
      -          "transform_response_html"
      -        ],
      -        "type": "string"
      -      },
      -      "action_parameters": {
      -        "properties": {
      -          "link_maze": {
      -            "description": "Enables the link maze transformation on the response.",
      -            "title": "Link Maze",
      -            "type": "object"
      -          }
      -        },
      -        "required": [
      -          "link_maze"
      -        ],
      -        "type": "object"
      -      },
      -      "description": {
      -        "type": "string"
      -      }
      -    },
      -    "title": "Transform Response HTML Rule",
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / payload / $defs / rulesets_ZoneId / $ref
      Added value: +"#/$defs/rulesets_ZoneId"
    • removedInput schema / properties / payload / $defs / rulesets_ZoneId / description
      Removed value: -"The unique ID of the zone."
    • removedInput schema / properties / payload / $defs / rulesets_ZoneId / pattern
      Removed value: -"^[0-9a-f]{32}$"
    • removedInput schema / properties / payload / $defs / rulesets_ZoneId / title
      Removed value: -"Zone ID"
    • removedInput schema / properties / payload / $defs / rulesets_ZoneId / type
      Removed value: -"string"
  2. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructive=true, idempotent=false, openWorld=true, so the safety profile is covered. The description adds value beyond that by disclosing the versioning behavior (each update makes a new version) and the confirmation/retry-safety requirement, which are not derivable from annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the core action and behavior. Nothing is padded, though the confirmation sentence is slightly ambiguous in wording ("unknown outcome").

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 7-parameter destructive mutation with a large nested payload and no output schema, the description is thin. It omits any guidance on version conflicts, dry_run semantics, or payload/payload_file exclusivity, leaving those gaps to the schema alone.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 71%, so the baseline is 3. The description only vaguely gestures at the confirm parameter via "explicit confirmation" and says nothing about dry_run, zone_id, ruleset_id, or the payload vs payload_file distinction.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Updates a zone ruleset") plus a useful behavioral fact ("creating a new version"). However it never names the sibling alternatives create_zone_ruleset or delete_zone_ruleset to differentiate the update path from them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The line about explicit confirmation and not repeating an unknown outcome gives implied operational guidance, but there is no explicit when-to-use statement, no prerequisites, and no comparison against the sibling create/delete ruleset tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.