Package :



Table of Contents


A RouteSpec defines the specification for an individual Route.

Field Type Description
disable Disable exposing this Route to API Consumers.
This is offered as means of easily disabling access to APIs without needing to remove the Route from an API Product..
backends [] Destination services for serving Operation requests. if more than one provided, requests will be split across these backends by the provided weights. At least one backend must be provided in order to route traffic with this RouteConfig..
headerManipulation manipulate headers for requests.


Message headers can be manipulated when Envoy forwards requests to, or responses from, a destination service.

Field Type Description
request Header manipulation rules to apply before forwarding a request to the destination service.
response Header manipulation rules to apply before returning a response to the caller.


HeaderOperations Describes the header manipulations to apply

Field Type Description
set Overwrite the headers specified by key with the given values.
add Append the given values to the headers specified by keys (will create a comma-separated list of values).
remove string Remove a the specified headers.


Field Type Description
key string .
value string .


Field Type Description
key string .
value string .


RouteSpecifier provides a generic way to specify a route as either a Ref to a route CR, or by directly inlining a RouteSpec. RouteSpecifiers can be defined in API Docs as well as API Products to control how routes exposed to those APIs will be configured.

Field Type Description
routeRef a reference to a Route resource. This is useful for reusing routes across operations..
inlineRoute Provide a route specification directly on the Operation..


status of the Route. contains a list of the locations where the Route is referenced

Field Type Description
observedGeneration The observed generation of the Route. When this matches the Route’s metadata.generation, it indicates the status is up-to-date..
state The current state of the Route..
reason A human-readable string explaining the error, if any..


RoutingDestination defines a backend (HTTP server) which serves API traffic

Field Type Description
kube Route requests to a kubernetes service.
consul Route requests to a consul service. Not supported in Istio. Not currently implemented..
lambda Route to a Lambda Function. Not supported in Istio. Not currently implemented..
static Route to a Static IP or Host. Not currently implemented..
weight optional weight for the destination. ignored if only one destination appears in the route..


Identifies an AWS Lambda function to route requests to

Field Type Description
logicalName string the logical name gloo should associate with this function. if left empty, it will default to lambda_function_name+qualifier.
lambdaFunctionName string The Name of the Lambda Function as it appears in the AWS Lambda Portal.
qualifier string The Qualifier for the Lambda Function. Qualifiers act as a kind of version for Lambda Functions. See for more info..
invocationStyle Can be either Sync or Async..
responseTransformation bool de-jsonify response bodies returned from aws lambda.


Identifies a Consul service to route traffic to. Multiple Consul services with the same name can present distinct sets of tags, listen of different ports, and live in multiple data centers (see an example here). You can target the desired subset of services via the fields in this configuration. Gloo will detect the correspondent IP addresses and ports and load balance traffic between them.

Field Type Description
serviceName string The name of the target service. This field is required..
tags string If provided, load balance traffic only between services matching all the given tags..
dataCenters string If provided, load balance traffic only between services running in the given data centers..


Identifies a port on a kubernetes service to route traffic to.

Field Type Description
name string Name of the Kubernetes service.
namespace string Namespace of the Kubernetes service.
port uint32 The ServicePort to which to route traffic.
subset optional labels for defining a destination which is a subset of the service. not currently implemented..


Field Type Description
key string .
value string .


a statically-defined destination for a Route

Field Type Description
hosts A list of addresses and ports at least one must be specified.


Represents a single instance of a static destination

Field Type Description
addr string Address (hostname or IP).
port uint32 Port the instance is listening on.


Name Number Description