Apache APISIX Stream Route

A Stream Route is used for Layer 4 (TCP/UDP) traffic proxying.

ApacheAPI GatewayCloud NativeKubernetesLuaNGINXOpen SourceTraffic Management

Properties

Name	Type	Description
desc	string	Description of the stream route.
remote_addr	string	Client IP address to match.
server_addr	string	Server address to match.
server_port	integer	Server port to match.
sni	string	Server Name Indication value to match.
plugins	object	Plugin configuration for the stream route.
upstream	object	Inline upstream configuration.
upstream_id	string	ID of an existing upstream to use.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/apache-apisix/blob/main/json-schema/stream-route.json",
  "title": "Apache APISIX Stream Route",
  "description": "A Stream Route is used for Layer 4 (TCP/UDP) traffic proxying.",
  "type": "object",
  "properties": {
    "desc": {
      "type": "string",
      "description": "Description of the stream route."
    },
    "remote_addr": {
      "type": "string",
      "description": "Client IP address to match."
    },
    "server_addr": {
      "type": "string",
      "description": "Server address to match."
    },
    "server_port": {
      "type": "integer",
      "description": "Server port to match."
    },
    "sni": {
      "type": "string",
      "description": "Server Name Indication value to match."
    },
    "plugins": {
      "type": "object",
      "description": "Plugin configuration for the stream route."
    },
    "upstream": {
      "$ref": "upstream.json",
      "description": "Inline upstream configuration."
    },
    "upstream_id": {
      "type": "string",
      "description": "ID of an existing upstream to use."
    }
  }
}