Skip to main content

Http Route

HttpRoute​

Defines the high-level intent for routing HTTP(S) traffic.

The engine turns it into mesh routes or load balancer URL maps. It supports path-based routing, header manipulation, and traffic splitting.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be HttpRoute.
metadatamapFree-form key/value labels. The engine reads reserved keys (for example name, project) to resolve the identity of this manifest and its parent ingress (PublicIngress or PrivateIngress).
specSpecDesired HTTP route configuration. See Spec.

Target​

Resolved backend target of the route.

Set when a rule destination targets an Agent (kind AGENT). Informational: the executor does not read it yet.

PropertyTypeDescription
kindstringTarget resource kind, for example AGENT.
namestringName of the resolved backend target manifest.

Spec​

User-defined HTTP routing rules.

The engine turns the rules into mesh route rules and load-balancer URL-map paths on the parent ingress.

PropertyTypeDescription
descriptionstringOptional free text. It appears in generated documentation, and AI assistants use it as context. The engine does not use it otherwise.
ruleslist of HttpRouteRuleOrdered list of rules. See HttpRouteRule. Each rule becomes a mesh route rule and load-balancer URL-map paths on the parent ingress, bound to a hostname from the manifest name. The engine reorders rules by match specificity, so more specific matches win.
ingressPathstringPath from the public load balancer to the destination: MESH or DIRECT. If empty, the engine uses MESH.
directReasonstringNOT RECOMMENDED. Reason why this route skips the mesh gateway. Use it only with ingress_path DIRECT. A DIRECT route is not the recommended secure way to expose a service. Use MESH, which is the default. Use DIRECT only for a service that checks bearer tokens itself and needs the original Authorization header.

HttpRouteRule​

HTTP routing rule.

Pairs match conditions with an action.

PropertyTypeDescription
matcheslist of HttpRouteRuleMatchConditions that select requests for this rule. A request matches if any condition holds.
authenticationlist of RouteRuleAuthenticationConfigAuthentication configuration. If not set, the rule needs no authentication.
authorizationlist of ComputedAuthorizationAccessRuleCheckAuthorization configuration. If not set, the rule is open to all users.

ComputedAuthorizationAccessRuleCheck​

Computed access check for a route rule.

The identity tuple (namespace, relation, object) that the authorization extension checks.

PropertyTypeDescription
namespacestringCopy of spec.authorization.namespace of the child HttpRoute or GrpcRoute manifest.
relationstringCopy of spec.authorization.relation of the child HttpRoute or GrpcRoute manifest.
objectstringCopy of spec.authorization.object of the child HttpRoute or GrpcRoute manifest.

RouteRuleAuthenticationConfig​

Authentication exceptions for a route rule.

Sets how authentication works for the paths that the rule matches.

PropertyTypeDescription
typestringIDENTITY_PROVIDER limits access to the identity providers in tenants. INTERNAL limits access to internal callers. Validation checks it against the declared identity providers.
tenantslist of stringIdentityProvider names that can access this route. Only for type IDENTITY_PROVIDER. Each entry must reference a provider that exists.

HttpRouteRuleMatch​

Match criteria for an HTTP request.

Selects requests by path, header or query parameter.

PropertyTypeDescription
ignoreCaseboolIf true, path comparisons ignore case.
fullPathMatchstringMatches if the request path equals this value. Mutually exclusive with prefix_match and regex_match.
prefixMatchstringMatches if the request path starts with this prefix.
regexMatchstringMatches if the request path fully matches this regular expression.
headerslist of HttpRouteRuleMatchHeaderConditions on request headers. All must match.
queryParameterslist of QueryParameterMatchConditions on URL query parameters. All must match.

QueryParameterMatch​

Condition on an HTTP query parameter.

A route match uses it to select requests by URL query parameter.

PropertyTypeDescription
queryParameterstringName of the URL query parameter to test.
exactMatchstringMatches if the parameter value equals this string.
regexMatchstringMatches if the parameter value fully matches this regular expression.
presentMatchstringIf set, matches if the parameter is present, whatever its value.

HttpRouteRuleMatchHeader​

Condition on an HTTP header.

A route match uses it to select requests by header.

PropertyTypeDescription
headerstringName of the request header to test.
invertMatchboolIf true, the rule applies when the header condition does NOT hold.
exactMatchstringMatches if the header value equals this string.
regexMatchstringMatches if the header value fully matches this regular expression.
prefixMatchstringMatches if the header value starts with this prefix.
presentMatchboolIf true, matches if the header is present, whatever its value.
suffixMatchstringMatches if the header value ends with this suffix.
rangeMatchRangeMatchMatches if the header value is an integer in this range.

RangeMatch​

Integer range for a header test.

A header condition matches a header value against this range.

PropertyTypeDescription
startint64Lower bound (inclusive): the smallest integer that matches.
endint64Upper bound (exclusive): one more than the largest integer that matches.