rulesets_SkipRule

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/rulesets_SkipRule",
  "title": "rulesets_SkipRule",
  "allOf": [
    {
      "$ref": "#/components/schemas/rulesets_Rule"
    },
    {
      "properties": {
        "action": {
          "enum": [
            "skip"
          ]
        },
        "action_parameters": {
          "example": {
            "ruleset": "current"
          },
          "minProperties": 1,
          "properties": {
            "phases": {
              "description": "A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.",
              "items": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/rulesets_RulesetPhase"
                  },
                  {
                    "description": "A phase to skip the execution of."
                  }
                ]
              },
              "minItems": 1,
              "title": "Phases",
              "type": "array",
              "uniqueItems": true
            },
            "products": {
              "description": "A list of legacy security products to skip the execution of.",
              "items": {
                "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"
              },
              "minItems": 1,
              "title": "Products",
              "type": "array",
              "uniqueItems": true
            },
            "rules": {
              "additionalProperties": {
                "description": "A list of rule IDs in the ruleset to skip the execution of.",
                "items": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/rulesets_RuleId"
                    },
                    {
                      "description": "The ID of a rule in the ruleset to skip the execution of.",
                      "example": "8ac8bc2a661e475d940980f9317f28e1",
                      "title": "Rule"
                    }
                  ]
                },
                "minItems": 1,
                "title": "Rules",
                "type": "array",
                "uniqueItems": true
              },
              "description": "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.",
              "example": {
                "4814384a9e5d4991b9815dcfc25d2f1f": [
                  "8ac8bc2a661e475d940980f9317f28e1"
                ]
              },
              "minProperties": 1,
              "title": "Rules",
              "type": "object"
            },
            "ruleset": {
              "description": "A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options.",
              "enum": [
                "current"
              ],
              "title": "Ruleset",
              "type": "string"
            },
            "rulesets": {
              "description": "A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.",
              "items": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/rulesets_RulesetId"
                  },
                  {
                    "description": "The ID of a ruleset to skip the execution of.",
                    "example": "4814384a9e5d4991b9815dcfc25d2f1f",
                    "title": "Ruleset"
                  }
                ]
              },
              "minItems": 1,
              "title": "Rulesets",
              "type": "array",
              "uniqueItems": true
            }
          }
        },
        "description": {
          "example": "Skip the current ruleset when the IP address is not 1.1.1.1"
        }
      },
      "title": "Skip rule"
    }
  ]
}