Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
      Docs Contribution Guidelines
      Want to help out, or found an issue in the docs and want to let us know?
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
3.2.x
  • Home icon
  • Kong Gateway
  • Reference
  • Router Expressions Language Reference for Kong Gateway
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.4.x (latest)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • General design
  • Types
  • Available fields
  • String
  • String transformations
  • Integer
  • IpAddr
  • Boolean
  • More information
You are browsing documentation for an outdated version. See the latest documentation here.

Router Expressions Language Reference for Kong Gateway

With the release of version 3.0, Kong Gateway now ships with a new router. The new router can describe routes using a domain-specific language called Expressions. Expressions can describe routes or paths as combinations of logical operations called “predicates”. This document serves as a reference for all of the available operators and fields. If you want to learn how to configure routes using Expressions read How to configure routes using Expressions.

General design

Kong router Expressions are designed as combinations of simple comparisons called “predicates”. All predicates have one of the following form:

field op value
transformation(field) op value

Example:

http.path ^= "/prefix/"
lower(http.path) ^= "/prefix/"

Note: transformations only works on fields, it will not work on the value side of the predicate. This means you can not write:

http.path ^= lower("/preFIX/")

Predicates can be grouped with parenthesis () or logical operators ||, &&:

Example:

(http.path ^= "/prefix/" && net.port == 80) || http.method == "POST"

Types

Router expressions are strongly typed. The operators available to each field depends on the type of that field. For example, you can not perform string comparisons on a integer type field.

Available fields

Field Description Type
net.protocol The protocol used to communicate with the downstream application. String
net.port Server end port number. Int
tls.sni Server name indication. String
http.method HTTP methods that match a route. String
http.host Lists of domains that match a route. String
http.path Normalized request path (without query parameters). String
http.headers.header_name Value of header Header-Name. Header names are converted to lower case, and - are replaced to _. String
net.src.ip Source IP address of incoming connection. IpAddr
net.src.port Source port number of incoming connection. Int
net.dst.ip Destination IP address of incoming connection. IpAddr
net.dst.port Destination port number of incoming connection. Int

String

Operator Meaning
== Equals
!= Not equals
~ Regex matching
^= Prefix matching
=^ Suffix matching
contains Contains

String transformations

Transformation Meaning
lower() turn the uppercase letters into lowercase

Integer

Operator Meaning
== Equals
!= Not equals
> Greater than
>= Greater than or equal
< Less than
<= Less than or equal

IpAddr

Operator Meaning
== Equals
!= Not equals
in In CIDR
not in Not in CIDR

Boolean

Operator Meaning
&& Logical And
|| Logical Or

More information

  • Expressions repository
  • How to configure routes using Expressions
Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023