rulesets_SetConfigRule

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-rulesets-setconfigrule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/rulesets_SetConfigRule",
  "title": "rulesets_SetConfigRule",
  "allOf": [
    {
      "$ref": "#/components/schemas/rulesets_Rule"
    },
    {
      "properties": {
        "action": {
          "enum": [
            "set_config"
          ]
        },
        "action_parameters": {
          "properties": {
            "automatic_https_rewrites": {
              "description": "Turn on or off Automatic HTTPS Rewrites.",
              "title": "Automatic HTTPS rewrites",
              "type": "boolean"
            },
            "autominify": {
              "description": "Select which file extensions to minify automatically.",
              "properties": {
                "css": {
                  "description": "Minify CSS files.",
                  "title": "CSS",
                  "type": "boolean"
                },
                "html": {
                  "description": "Minify HTML files.",
                  "title": "HTML",
                  "type": "boolean"
                },
                "js": {
                  "description": "Minify JS files.",
                  "title": "JS",
                  "type": "boolean"
                }
              },
              "title": "Auto Minify",
              "type": "object"
            },
            "bic": {
              "description": "Turn on or off Browser Integrity Check.",
              "title": "Browser Integrity Check",
              "type": "boolean"
            },
            "disable_apps": {
              "description": "Turn off all active Cloudflare Apps.",
              "enum": [
                true
              ],
              "title": "Disable Apps",
              "type": "boolean"
            },
            "disable_rum": {
              "description": "Turn off Real User Monitoring (RUM).",
              "enum": [
                true
              ],
              "title": "Disable RUM",
              "type": "boolean"
            },
            "disable_zaraz": {
              "description": "Turn off Zaraz.",
              "enum": [
                true
              ],
              "title": "Disable Zaraz",
              "type": "boolean"
            },
            "email_obfuscation": {
              "description": "Turn on or off Email Obfuscation.",
              "title": "Email Obfuscation",
              "type": "boolean"
            },
            "fonts": {
              "description": "Turn on or off Cloudflare Fonts.",
              "title": "Cloudflare Fonts",
              "type": "boolean"
            },
            "hotlink_protection": {
              "description": "Turn on or off the Hotlink Protection.",
              "title": "Hotlink Protection",
              "type": "boolean"
            },
            "mirage": {
              "description": "Turn on or off Mirage.",
              "title": "Mirage",
              "type": "boolean"
            },
            "opportunistic_encryption": {
              "description": "Turn on or off Opportunistic Encryption.",
              "title": "Opportunistic Encryption",
              "type": "boolean"
            },
            "polish": {
              "description": "Configure the Polish level.",
              "enum": [
                "off",
                "lossless",
                "lossy"
              ],
              "title": "Polish",
              "type": "string"
            },
            "rocket_loader": {
              "description": "Turn on or off Rocket Loader",
              "title": "Rocket Loader",
              "type": "boolean"
            },
            "security_level": {
              "description": "Configure the Security Level.",
              "enum": [
                "off",
                "essentially_off",
                "low",
                "medium",
                "high",
                "under_attack"
              ],
              "title": "Security Level",
              "type": "string"
            },
            "server_side_excludes": {
              "description": "Turn on or off Server Side Excludes.",
              "title": "Server Side Excludes",
              "type": "boolean"
            },
            "ssl": {
              "description": "Configure the SSL level.",
              "enum": [
                "off",
                "flexible",
                "full",
                "strict",
                "origin_pull"
              ],
              "title": "SSL",
              "type": "string"
            },
            "sxg": {
              "description": "Turn on or off Signed Exchanges (SXG).",
              "title": "Signed Exchanges (SXG)",
              "type": "boolean"
            }
          }
        },
        "description": {
          "example": "Disable Zaraz when IP address is not 1.1.1.1"
        }
      },
      "title": "Set Config Rule"
    }
  ]
}