firewall_action_parameters_set_cache_settings

The configuration parameters for the set_cache_settings action.

APIs.ioEngineeringPlatform

Properties

Name Type Description
browser_ttl object Set the Browser TTL.
cache_key object Set the Cache TTL.
edge_ttl object Set the Cache TTL.
origin_error_page_passthru boolean
respect_strong_etags boolean
serve_stale object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-firewall-action-parameters-set-cache-settings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/firewall_action_parameters_set_cache_settings",
  "title": "firewall_action_parameters_set_cache_settings",
  "description": "The configuration parameters for the set_cache_settings action.",
  "properties": {
    "browser_ttl": {
      "description": "Set the Browser TTL.",
      "properties": {
        "default": {
          "type": "integer"
        },
        "mode": {
          "example": "override_origin",
          "type": "string"
        }
      },
      "type": "object"
    },
    "cache_key": {
      "description": "Set the Cache TTL.",
      "properties": {
        "cache_deception_armor": {
          "example": true,
          "type": "boolean"
        },
        "custom_key": {
          "properties": {
            "cookie": {
              "properties": {
                "check_presence": {
                  "example": [
                    "cookie_1"
                  ],
                  "items": {},
                  "type": "array"
                },
                "include": {
                  "example": [
                    "cookie1"
                  ],
                  "items": {},
                  "type": "array"
                }
              },
              "type": "object"
            },
            "header": {
              "properties": {
                "check_presence": {
                  "example": [
                    "header_1"
                  ],
                  "items": {},
                  "type": "array"
                },
                "include": {
                  "example": [
                    "header1"
                  ],
                  "items": {},
                  "type": "array"
                }
              },
              "type": "object"
            },
            "host": {
              "properties": {
                "resolved": {
                  "example": false,
                  "type": "boolean"
                }
              },
              "type": "object"
            },
            "query_string": {
              "properties": {
                "include": {
                  "example": "*",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "user": {
              "properties": {
                "device_type": {
                  "example": true,
                  "type": "boolean"
                },
                "geo": {
                  "example": false,
                  "type": "boolean"
                },
                "lang": {
                  "example": false,
                  "type": "boolean"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        },
        "ignore_query_strings_order": {
          "example": true,
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "edge_ttl": {
      "description": "Set the Cache TTL.",
      "properties": {
        "mode": {
          "example": "respect_origin",
          "type": "string"
        },
        "status_code_ttl": {
          "properties": {
            "status_code": {
              "type": "integer"
            },
            "value": {
              "type": "integer"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "origin_error_page_passthru": {
      "example": true,
      "type": "boolean"
    },
    "respect_strong_etags": {
      "example": true,
      "type": "boolean"
    },
    "serve_stale": {
      "properties": {
        "disable_stale_while_updating": {
          "example": true,
          "type": "boolean"
        }
      },
      "type": "object"
    }
  }
}