firewall_action_parameters_redirect

The configuration parameters for the redirect action.

APIs.ioEngineeringPlatform

Properties

Name Type Description
from_value object The parameters that control the redirect.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-firewall-action-parameters-redirect-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/firewall_action_parameters_redirect",
  "title": "firewall_action_parameters_redirect",
  "description": "The configuration parameters for the redirect action.",
  "properties": {
    "from_value": {
      "description": "The parameters that control the redirect.",
      "properties": {
        "preserve_query_string": {
          "description": "Whether the query string for the request should be carried to the redirect's target url.",
          "example": true,
          "type": "boolean"
        },
        "status_code": {
          "description": "The status code to use for the redirect.",
          "type": "integer"
        },
        "target_url": {
          "oneOf": [
            {
              "properties": {
                "expression": {
                  "description": "An expression defining a dynamic value for the target url of the redirect.",
                  "example": "concat(http.request.full_uri, \"/latest\")",
                  "type": "string"
                }
              },
              "type": "object"
            },
            {
              "properties": {
                "value": {
                  "description": "The value defining the target url of the redirect.",
                  "example": "https://example.com/blog/latest",
                  "type": "string"
                }
              },
              "type": "object"
            }
          ]
        }
      },
      "type": "object"
    }
  }
}