List available Page Rules settings

Returns a list of settings (and their details) that Page Rules can apply to matching requests.

application/json

Body

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

result

settings

required

Settings available for the zone.

Any of

allOf {2}

array [object]

allOf {2}

One of

settings

object

Settings available for the zone.

Example:

[{"id":"browser_check","properties":[{"name":"value","type":"toggle"}]},{"id":"browser_cache_ttl","properties":[{"max":31536000,"min":1800,"name":"value","suggested_values":[1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,691200,1382400,2073600,2678400,5356800,16070400,31536000],"type":"range"}]},{"id":"browser_check","properties":[{"name":"value","type":"toggle"}]},{"id":"cache_key_fields","properties":[{"name":"value","properties":[{"allowEmpty":true,"choices":["include","exclude"],"multiple":false,"name":"query_string","type":"select"},{"allowEmpty":true,"choices":["include","exclude","check_presence"],"multiple":true,"name":"header","type":"select"},{"allowEmpty":false,"choices":["resolved"],"multiple":true,"name":"host","type":"select"},{"allowEmpty":true,"choices":["include","check_presence"],"multiple":true,"name":"cookie","type":"select"},{"allowEmpty":false,"choices":["device_type","geo","lang"],"multiple":true,"name":"user","type":"select"}],"type":"object"}]},{"id":"cache_deception_armor","properties":[{"name":"value","type":"toggle"}]},{"id":"cache_level","properties":[{"choices":["bypass","basic","simplified","aggressive","cache_everything"],"multiple":false,"name":"value","type":"select"}]},{"id":"cache_ttl_by_status","properties":[{"allowEmpty":false,"name":"value","type":"object"}]},{"id":"disable_apps","properties":[]},{"id":"disable_performance","properties":[]},{"id":"disable_security","properties":[]},{"id":"edge_cache_ttl","properties":[{"max":2419200,"min":7200,"name":"value","suggested_values":[7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,518400,604800,1209600,2419200],"type":"range"}]},{"id":"email_obfuscation","properties":[{"name":"value","type":"toggle"}]},{"id":"forwarding_url","properties":[{"choices":[301,302],"multiple":false,"name":"status_code","type":"choice"},{"name":"url","type":"forwardingUrl"}]},{"id":"ip_geolocation","properties":[{"name":"value","type":"toggle"}]},{"id":"minify","properties":[{"allowEmpty":true,"choices":["html","css","js"],"multiple":true,"name":"value","type":"select"}]},{"id":"explicit_cache_control","properties":[{"name":"value","type":"toggle"}]},{"id":"rocket_loader","properties":[{"name":"value","type":"toggle"}]},{"id":"security_level","properties":[{"choices":["essentially_off","low","medium","high","under_attack"],"multiple":false,"name":"value","type":"select"}]},{"id":"server_side_exclude","properties":[{"name":"value","type":"toggle"}]},{"id":"ssl","properties":[{"choices":["off","flexible","full","strict"],"multiple":false,"name":"value","type":"choice"}]}]

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "browser_check",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "browser_cache_ttl",
      "properties": [
        {
          "max": 31536000,
          "min": 1800,
          "name": "value",
          "suggested_values": [
            1800,
            3600,
            7200,
            10800,
            14400,
            18000,
            28800,
            43200,
            57600,
            72000,
            86400,
            172800,
            259200,
            345600,
            432000,
            691200,
            1382400,
            2073600,
            2678400,
            5356800,
            16070400,
            31536000
          ],
          "type": "range"
        }
      ]
    },
    {
      "id": "browser_check",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "cache_key_fields",
      "properties": [
        {
          "name": "value",
          "properties": [
            {
              "allowEmpty": true,
              "choices": [
                "include",
                "exclude"
              ],
              "multiple": false,
              "name": "query_string",
              "type": "select"
            },
            {
              "allowEmpty": true,
              "choices": [
                "include",
                "exclude",
                "check_presence"
              ],
              "multiple": true,
              "name": "header",
              "type": "select"
            },
            {
              "allowEmpty": false,
              "choices": [
                "resolved"
              ],
              "multiple": true,
              "name": "host",
              "type": "select"
            },
            {
              "allowEmpty": true,
              "choices": [
                "include",
                "check_presence"
              ],
              "multiple": true,
              "name": "cookie",
              "type": "select"
            },
            {
              "allowEmpty": false,
              "choices": [
                "device_type",
                "geo",
                "lang"
              ],
              "multiple": true,
              "name": "user",
              "type": "select"
            }
          ],
          "type": "object"
        }
      ]
    },
    {
      "id": "cache_deception_armor",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "cache_level",
      "properties": [
        {
          "choices": [
            "bypass",
            "basic",
            "simplified",
            "aggressive",
            "cache_everything"
          ],
          "multiple": false,
          "name": "value",
          "type": "select"
        }
      ]
    },
    {
      "id": "cache_ttl_by_status",
      "properties": [
        {
          "allowEmpty": false,
          "name": "value",
          "type": "object"
        }
      ]
    },
    {
      "id": "disable_apps",
      "properties": []
    },
    {
      "id": "disable_performance",
      "properties": []
    },
    {
      "id": "disable_security",
      "properties": []
    },
    {
      "id": "edge_cache_ttl",
      "properties": [
        {
          "max": 2419200,
          "min": 7200,
          "name": "value",
          "suggested_values": [
            7200,
            10800,
            14400,
            18000,
            28800,
            43200,
            57600,
            72000,
            86400,
            172800,
            259200,
            345600,
            432000,
            518400,
            604800,
            1209600,
            2419200
          ],
          "type": "range"
        }
      ]
    },
    {
      "id": "email_obfuscation",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "forwarding_url",
      "properties": [
        {
          "choices": [
            301,
            302
          ],
          "multiple": false,
          "name": "status_code",
          "type": "choice"
        },
        {
          "name": "url",
          "type": "forwardingUrl"
        }
      ]
    },
    {
      "id": "ip_geolocation",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "minify",
      "properties": [
        {
          "allowEmpty": true,
          "choices": [
            "html",
            "css",
            "js"
          ],
          "multiple": true,
          "name": "value",
          "type": "select"
        }
      ]
    },
    {
      "id": "explicit_cache_control",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "rocket_loader",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "security_level",
      "properties": [
        {
          "choices": [
            "essentially_off",
            "low",
            "medium",
            "high",
            "under_attack"
          ],
          "multiple": false,
          "name": "value",
          "type": "select"
        }
      ]
    },
    {
      "id": "server_side_exclude",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "ssl",
      "properties": [
        {
          "choices": [
            "off",
            "flexible",
            "full",
            "strict"
          ],
          "multiple": false,
          "name": "value",
          "type": "choice"
        }
      ]
    }
  ],
  "success": true
}

List available Page Rules settings

Request

Request samples

Responses