rulesets_RouteRule

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-rulesets-routerule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/rulesets_RouteRule",
  "title": "rulesets_RouteRule",
  "allOf": [
    {
      "$ref": "#/components/schemas/rulesets_Rule"
    },
    {
      "properties": {
        "action": {
          "enum": [
            "route"
          ]
        },
        "action_parameters": {
          "properties": {
            "host_header": {
              "description": "Rewrite the HTTP Host header.",
              "example": "static.example.com",
              "minLength": 1,
              "title": "Host Header",
              "type": "string"
            },
            "origin": {
              "description": "Override the IP/TCP destination.",
              "properties": {
                "host": {
                  "description": "Override the resolved hostname.",
                  "example": "static.example.com",
                  "minLength": 1,
                  "title": "DNS Record",
                  "type": "string"
                },
                "port": {
                  "description": "Override the destination port.",
                  "maximum": 65535,
                  "minimum": 1,
                  "title": "Port",
                  "type": "number"
                }
              },
              "title": "Origin",
              "type": "object"
            },
            "sni": {
              "description": "Override the Server Name Indication (SNI).",
              "properties": {
                "value": {
                  "description": "The SNI override.",
                  "example": "static.example.com",
                  "minLength": 1,
                  "title": "Value",
                  "type": "string"
                }
              },
              "required": [
                "value"
              ],
              "title": "SNI",
              "type": "object"
            }
          }
        },
        "description": {
          "example": "Select origin server when IP address is not 1.1.1.1"
        }
      },
      "title": "Origin rule"
    }
  ]
}