ForwardProxyPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ForwardProxyPluginConfig",
  "title": "ForwardProxyPluginConfig",
  "x-speakeasy-entity": "PluginForwardProxy",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "auth_password": {
          "description": "The password to authenticate with, if the forward proxy is protected\nby basic authentication.",
          "type": "string",
          "x-encrypted": true,
          "x-referenceable": true
        },
        "auth_username": {
          "description": "The username to authenticate with, if the forward proxy is protected\nby basic authentication.",
          "type": "string",
          "x-referenceable": true
        },
        "http_proxy_host": {
          "description": "A string representing a host name, such as example.com.",
          "type": "string"
        },
        "http_proxy_port": {
          "description": "An integer representing a port number between 0 and 65535, inclusive.",
          "type": "integer",
          "maximum": 65535,
          "minimum": 0
        },
        "https_proxy_host": {
          "description": "A string representing a host name, such as example.com.",
          "type": "string"
        },
        "https_proxy_port": {
          "description": "An integer representing a port number between 0 and 65535, inclusive.",
          "type": "integer",
          "maximum": 65535,
          "minimum": 0
        },
        "https_verify": {
          "description": "Whether the server certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.",
          "type": "boolean",
          "default": true
        },
        "proxy_scheme": {
          "description": "The proxy scheme to use when connecting. Only `http` is supported.",
          "type": "string",
          "default": "http",
          "enum": [
            "http"
          ]
        },
        "x_headers": {
          "description": "Determines how to handle headers when forwarding the request.",
          "type": "string",
          "default": "append",
          "enum": [
            "append",
            "delete",
            "transparent"
          ]
        }
      }
    },
    "consumer": {
      "description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "name": {
      "const": "forward-proxy"
    },
    "protocols": {
      "description": "A set of strings representing HTTP protocols.",
      "type": "array",
      "items": {
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}