Apache APISIX · Schema

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

stream-route.json Raw ↑
{
  "$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."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/stream-route"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.