Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 2.1.x (latest)
  • 2.0.x
  • 1.9.x
  • 1.8.x
  • 1.7.x
  • 1.6.x
  • 1.5.x
  • 1.4.x
  • 1.3.x
  • 1.2.x
  • 1.1.x
  • 1.0.x
    • Introduction to Kong Mesh
    • What is Service Mesh?
    • How Kong Mesh works
    • Deployments
    • Version support policy
    • Stability
    • Release notes
    • Installation Options
    • Kubernetes
    • Helm
    • OpenShift
    • Docker
    • Amazon ECS
    • Amazon Linux
    • Red Hat
    • CentOS
    • Debian
    • Ubuntu
    • macOS
    • Windows
    • Explore Kong Mesh with the Kubernetes demo app
    • Explore Kong Mesh with the Universal demo app
    • Standalone deployment
    • Multi-zone deployment
    • License
    • Overview
    • Data plane proxy
    • Data plane on Kubernetes
    • Data plane on Universal
    • Gateway
    • Zone Ingress
    • Zone Egress
    • CLI
    • GUI
    • Observability
    • Inspect API
    • Kubernetes Gateway API
    • Networking
    • Service Discovery
    • DNS
    • Kong Mesh CNI
    • Transparent Proxying
    • IPv6 support
    • Non-mesh traffic
    • Secure access across Kong Mesh components
    • Secrets
    • Kong Mesh API Access Control
    • API server authentication
    • Data plane proxy authentication
    • Zone proxy authentication
    • Data plane proxy membership
    • Dataplane Health
    • Fine-tuning
    • Control Plane Configuration
    • Upgrades
    • Requirements
    • Introduction
    • General notes about Kong Mesh policies
    • Applying Policies
    • How Kong Mesh chooses the right policy to apply
    • Understanding TargetRef policies
    • Protocol support in Kong Mesh
    • Mesh
    • Mutual TLS
    • Traffic Permissions
    • Traffic Route
    • Traffic Metrics
    • Traffic Trace
    • Traffic Log
    • Locality-aware Load Balancing
    • Fault Injection
    • Health Check
    • Circuit Breaker
    • Proxy Template
    • External Service
    • Retry
    • Timeout
    • Rate Limit
    • Virtual Outbound
    • MeshGateway
    • MeshGatewayRoute
    • Service Health Probes
    • MeshAccessLog (Beta)
    • MeshCircuitBreaker (Beta)
    • MeshFaultInjection (Beta)
    • MeshHealthCheck (Beta)
    • MeshHTTPRoute (Beta)
    • MeshProxyPatch (Beta)
    • MeshRateLimit (Beta)
    • MeshRetry (Beta)
    • MeshTimeout (Beta)
    • MeshTrace (Beta)
    • MeshTrafficPermission (Beta)
    • Overview
    • HashiCorp Vault CA
    • Amazon ACM Private CA
    • cert-manager Private CA
    • OPA policy support
    • MeshOPA (beta)
    • Multi-zone authentication
    • FIPS support
    • Certificate Authority rotation
    • Role-Based Access Control
    • UBI Images
    • Windows Support
    • Auditing
    • HTTP API
    • Annotations and labels in Kubernetes mode
    • Kong Mesh data collection
      • Mesh
      • CircuitBreaker
      • ExternalService
      • FaultInjection
      • HealthCheck
      • MeshGateway
      • MeshGatewayRoute
      • ProxyTemplate
      • RateLimit
      • Retry
      • Timeout
      • TrafficLog
      • TrafficPermission
      • TrafficRoute
      • TrafficTrace
      • VirtualOutbound
      • Dataplane
      • ZoneEgress
      • ZoneIngress
      • kuma-cp
      • kuma-dp
      • kumactl
    • Kuma-cp configuration reference
    • Open source License
    • Contribute to Mesh

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

Kong Mesh
2.1.x (latest)
  • Home
  • Kong Mesh
  • Generated
  • Resources
  • MeshGatewayRoute

MeshGatewayRoute

  • selectors (required, repeated)

    Selectors is used to match this resource to MeshGateway listener.

    • match (optional)

      Tags to match, can be used for both source and destinations

  • conf (required)

    Conf specifies the route configuration.

    • tcp (optional)

      • rules (required, repeated)

        • backends (required, repeated)

          • weight (required)

            Weight is the proportion of requests this backend will receive when a forwarding rules specifies multiple backends. Traffic weight is computed as “weight/sum(all weights)”.

            A weight of 0 means that the destination will be ignored.

          • destination (required)

            Destination is a selector to match the individual endpoints to which the gateway will forward.

    • http (optional)

      • hostnames (optional, repeated)

        Hostnames lists the server names for which this route is valid. The hostnames are matched against the TLS Server Name Indication extension if this is a TLS session. They are also matched against the HTTP host (authority) header in the client’s HTTP request.

      • rules (required, repeated)

        Rules specifies how the gateway should match and process HTTP requests.

        • matches (required, repeated)

          Matches are checked in order. If any match is successful, the rule is selected (OR semantics).

          • path (optional)

            • match (optional, enum)

              • EXACT

              • PREFIX

              • REGEX

            • value (required)

              Value is the path to match against. For EXACT and PREFIX match types, it must be a HTTP URI path. For the REGEX match type, it must be a RE2 regular expression. Note that a PREFIX match succeeds only if the prefix is the the entire path or is followed by a /. I.e. a prefix of the path in terms of path elements.

          • method (optional, enum)

            • NONE

            • CONNECT

            • DELETE

            • GET

            • HEAD

            • OPTIONS

            • PATCH

            • POST

            • PUT

            • TRACE

          • headers (optional, repeated)

            • match (optional, enum)

              • EXACT

              • REGEX

              • ABSENT

              • PRESENT

            • name (required)

              Name of the HTTP header containing the value to match.

            • value (required)

              Value that the HTTP header value should be matched against.

          • queryParameters (optional, repeated)

            • match (optional, enum)

              • EXACT

              • REGEX

            • name (required)

              Name of the query parameter containing the value to match.

            • value (required)

              Value that the query parameter value should be matched against.

        • filters (optional, repeated)

          Filters are request processing steps that are applied to matched requests.

          If the redirect filter is specified, it must be the only filter given.

          • requestHeader (optional)

            • set (optional, repeated)

              • name (required)

              • value (required)

            • add (optional, repeated)

              • name (required)

              • value (required)

            • remove (optional, repeated)

          • mirror (optional)

            • backend (required)

              Backend denotes the service to which requests will be mirrored. The “weight” field must not be given.

              • weight (required)

                Weight is the proportion of requests this backend will receive when a forwarding rules specifies multiple backends. Traffic weight is computed as “weight/sum(all weights)”.

                A weight of 0 means that the destination will be ignored.

              • destination (required)

                Destination is a selector to match the individual endpoints to which the gateway will forward.

            • percentage (required)

              Percentage specifies the percentage of requests to mirror to the backend (in the range 0.0 - 100.0, inclusive).

          • redirect (optional)

            • scheme (required)

              The scheme for the redirect URL. Usually “http” or “https”.

            • hostname (required)

              The hostname to redirect to.

            • port (optional)

              The port to redirect to.

            • statusCode (required)

              The HTTP response status code. This must be in the range 300 - 308.

          • rewrite (optional)

            • replaceFull (optional)

            • replacePrefixMatch (optional)

              Note that rewriting “/prefix” to “/” will do the right thing:

              • the path “/prefix” is rewritten to “/”
              • the path “/prefix/rest” is rewritten to “/rest”
          • responseHeader (optional)

            • set (optional, repeated)

              • name (required)

              • value (required)

            • add (optional, repeated)

              • name (required)

              • value (required)

            • remove (optional, repeated)

        • backends (optional, repeated)

          Backends is the set of services to which the gateway will forward requests. If a redirect filter is specified, no backends are allowed. Otherwise, at least one backend must be given.

          • weight (required)

            Weight is the proportion of requests this backend will receive when a forwarding rules specifies multiple backends. Traffic weight is computed as “weight/sum(all weights)”.

            A weight of 0 means that the destination will be ignored.

          • destination (required)

            Destination is a selector to match the individual endpoints to which the gateway will forward.

Thank you for your feedback.
Was this page useful?
  • 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