Apache APISIX · Schema
Apache APISIX Route
A Route defines rules to match client requests and specifies how to handle matched requests, including plugins and upstream configurations.
ApacheAPI GatewayCloud NativeKubernetesLuaNGINXOpen SourceTraffic Management
Properties
| Name | Type | Description |
|---|---|---|
| uri | string | The request URI path. Supports path prefixes with wildcard. |
| uris | array | A list of URIs for the route to match. |
| name | string | Human-readable name for the route. |
| desc | string | Description of the route. |
| host | string | Host to match for the route. |
| hosts | array | A list of hosts for the route to match. |
| methods | array | HTTP methods to match. |
| remote_addr | string | Client IP address to match. |
| remote_addrs | array | A list of client IP addresses to match. |
| vars | array | DSL expressions for matching request attributes. |
| priority | integer | Route priority for matching order. Higher value means higher priority. |
| plugins | object | Plugin configuration. Key is the plugin name and value is the plugin config. |
| upstream | object | Inline upstream configuration. |
| upstream_id | string | ID of an existing upstream to use. |
| service_id | string | ID of an existing service to bind to. |
| plugin_config_id | string | ID of a plugin config to bind to. |
| labels | object | Key-value pairs for categorization. |
| timeout | object | Timeout settings for upstream connections. |
| enable_websocket | boolean | Enable WebSocket proxying. |
| status | integer | Route status. 1 for enabled, 0 for disabled. |
| filter_func | string | A Lua function string for custom filtering logic. |