InterceptorRoute

InterceptorRoute ^Latest

Field-by-field API reference for the InterceptorRoute custom resource


API version	`http.keda.sh/v1beta1`
Kind	`InterceptorRoute`
Scope	Namespaced

Example

apiVersion: http.keda.sh/v1beta1
kind: InterceptorRoute
metadata:
  name: my-app
  namespace: default
spec:
  target:
    service: my-app-svc
    port: 8080
  rules:
    - hosts:
        - app.example.com
      paths:
        - value: /api
  scalingMetric:
    concurrency:
      targetValue: 100

`spec`

Field	Type	Required	Description
`target`	`TargetRef`	Yes	Backend service to route traffic to.
`rules`	`[]RoutingRule`	No	Routing rules that define how requests are matched to this target.
`scalingMetric`	`ScalingMetricSpec`	Yes	Metric configuration for autoscaling.
`coldStart`	`ColdStartSpec`	No	Cold start behavior when scaling from zero.
`timeouts`	`InterceptorRouteTimeouts`	No	Timeout configuration for request handling.

For usage guidance, see Configure Routing Rules and Configure Scaling Metrics.

`TargetRef`

Identifies a Service to route traffic to. Exactly one of port or portName must be set.

Field	Type	Required	Description
`service`	`string`	Yes	Name of the Kubernetes Service. Minimum length: 1.
`port`	`int32`	No	Port number on the Service (1–65535). Mutually exclusive with `portName`.
`portName`	`string`	No	Named port on the Service. Minimum length: 1. Mutually exclusive with `port`.

Validation: Exactly one of port or portName must be set. Setting both or neither produces a validation error.

`RoutingRule`

Defines a set of matching criteria for routing requests. All specified fields within a single rule use AND semantics (host AND path AND headers must match). Multiple rules use OR semantics (any rule can match).

Field	Type	Required	Description
`hosts`	`[]string`	No	Hostnames to match. Wildcard patterns (e.g., `.example.com`) are supported. A single `` acts as a catch-all. Exact matches take priority over wildcards; more specific wildcards (e.g., `*.bar.example.com`) take priority over less specific ones.
`paths`	`[]PathMatch`	No	Path prefixes to match. When multiple paths match, the longest prefix wins.
`headers`	`[]HeaderMatch`	No	Headers that must all match the request (AND semantics).

`PathMatch`

Field	Type	Required	Default	Description
`value`	`string`	Yes		Path prefix to match against. The longest matching prefix wins. Minimum length: 1.

`HeaderMatch`

Field	Type	Required	Default	Description
`name`	`string`	Yes		Name of the HTTP header. Minimum length: 1.
`value`	`*string`	No		Value to match against (exact match). If omitted, matches any value for the given header name.

`ScalingMetricSpec`

Defines what metric drives autoscaling. At least one of concurrency or requestRate must be set. When both are set, both metrics are reported and KEDA scales based on whichever demands more replicas.

Field	Type	Required	Default	Description
`concurrency`	`*ConcurrencyTargetSpec`	No		Scale based on concurrent request count.
`requestRate`	`*RequestRateTargetSpec`	No		Scale based on request rate.

Validation: At least one of concurrency or requestRate must be set.

`ConcurrencyTargetSpec`

Field	Type	Required	Default	Description
`targetValue`	`int32`	Yes		Target concurrent request count per replica. Minimum: 1.

`RequestRateTargetSpec`

Field	Type	Required	Default	Description
`targetValue`	`int32`	Yes		Target request rate per replica. Minimum: 1.
`window`	`Duration`	No	`1m`	Sliding time window over which the request rate is calculated.
`granularity`	`Duration`	No	`1s`	Bucket size for rate calculation within the window.

`ColdStartSpec`

Configures behavior while the target is not ready (scaling from zero).

Field	Type	Required	Default	Description
`fallback`	`*TargetRef`	Yes		Fallback service to route to when the target is scaling from zero and the wait timeout expires.

Validation: The fallback field must be set.

`InterceptorRouteTimeouts`

Configures per-route request handling timeouts. When a field is unset, the global interceptor timeout configuration (KEDA_HTTP_*_TIMEOUT environment variables) is used.

Field	Type	Required	Default	Description
`readiness`	`*Duration`	No	Global `KEDA_HTTP_READINESS_TIMEOUT`	Time to wait for the backend to become ready (e.g., scale from zero). Set to `0s` to disable the dedicated readiness deadline so the full request budget is available for cold starts. When a fallback service is configured and this is `0s`, a 30s default is applied.
`request`	`*Duration`	No	Global `KEDA_HTTP_REQUEST_TIMEOUT`	Total time allowed for the entire request lifecycle. Set to `0s` to disable the request deadline.
`responseHeader`	`*Duration`	No	Global `KEDA_HTTP_RESPONSE_HEADER_TIMEOUT`	Maximum time to wait for response headers from the backend after the request has been sent. Does not include cold-start wait time. Set to `0s` to disable the response header deadline.

`status`

Field	Type	Description
`conditions`	`[]metav1.Condition`	Conditions of the InterceptorRoute. Keyed by `type`.

Condition types

Type	Description
`Ready`	Whether the InterceptorRoute is fully reconciled and routing traffic.