Scale Intelligence■ Docs
Docs / The model / Route

Route.

One ingress route: a host and path prefix forwarded to one listener, over TLS

Figure 1Routespecified
ROUTEdefinition at platform scopehosttextpath_prefixtextonly an api-gateway listener may be a backendbackendListenertlsCertificatea route change must not drop a long-lived stream (D-37)keeps_open_streams_on_…boolrate_limitRateLimitoptionalLISTENERthrough backendCERTIFICATEthrough tlsRATELIMITthrough rate_limit
Route is a definition at platform scope. The drawing shows its fields and the objects that they point at.
kind
definition
scope
platform
key
the host and the path prefix
store
postgres
family
network

Fields#

fieldtyperequirednote
hosttextyes
path_prefixtextyes
backendListeneryesonly an api-gateway listener may be a backend
tlsCertificateyes
keeps_open_streams_on_changeboolyesa route change must not drop a long-lived stream
rate_limitRateLimitno

Routes that use it#

No route takes or returns Route directly. The record holds it, and the objects that point at it reach it.