Middleware v1alpha1 — traefik.io

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object required

spec object required

MiddlewareSpec defines the desired state of a Middleware.

addPrefix object

AddPrefix holds the add prefix middleware configuration. This middleware updates the path of a request before forwarding it. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/addprefix/

prefix string

Prefix is the string to add before the current path in the requested URL. It should include a leading slash (/).

basicAuth object

BasicAuth holds the basic auth middleware configuration. This middleware restricts access to your services to known users. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/basicauth/

headerField string

HeaderField defines a header field to store the authenticated user. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/basicauth/#headerfield

realm string

Realm allows the protected resources on a server to be partitioned into a set of protection spaces, each with its own authentication scheme. Default: traefik.

removeHeader boolean

RemoveHeader sets the removeHeader option to true to remove the authorization header before forwarding the request to your service. Default: false.

secret string

Secret is the name of the referenced Kubernetes Secret containing user credentials.

buffering object

Buffering holds the buffering middleware configuration. This middleware retries or limits the size of requests that can be forwarded to backends. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/buffering/#maxrequestbodybytes

maxRequestBodyBytes integer

MaxRequestBodyBytes defines the maximum allowed body size for the request (in bytes). If the request exceeds the allowed size, it is not forwarded to the service, and the client gets a 413 (Request Entity Too Large) response. Default: 0 (no maximum).

format: int64

maxResponseBodyBytes integer

MaxResponseBodyBytes defines the maximum allowed response size from the service (in bytes). If the response exceeds the allowed size, it is not forwarded to the client. The client gets a 500 (Internal Server Error) response instead. Default: 0 (no maximum).

format: int64

memRequestBodyBytes integer

MemRequestBodyBytes defines the threshold (in bytes) from which the request will be buffered on disk instead of in memory. Default: 1048576 (1Mi).

format: int64

memResponseBodyBytes integer

MemResponseBodyBytes defines the threshold (in bytes) from which the response will be buffered on disk instead of in memory. Default: 1048576 (1Mi).

format: int64

retryExpression string

RetryExpression defines the retry conditions. It is a logical combination of functions with operators AND (&&) and OR (||). More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/buffering/#retryexpression

chain object

Chain holds the configuration of the chain middleware. This middleware enables to define reusable combinations of other pieces of middleware. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/chain/

middlewares []object

Middlewares is the list of MiddlewareRef which composes the chain.

name string required

Name defines the name of the referenced Middleware resource.

namespace string

Namespace defines the namespace of the referenced Middleware resource.

circuitBreaker object

CircuitBreaker holds the circuit breaker configuration.

checkPeriod object

CheckPeriod is the interval between successive checks of the circuit breaker condition (when in standby state).

pattern: ^([0-9]+(ns|us|µs|ms|s|m|h)?)+$

expression string

Expression is the condition that triggers the tripped state.

fallbackDuration object

FallbackDuration is the duration for which the circuit breaker will wait before trying to recover (from a tripped state).

recoveryDuration object

RecoveryDuration is the duration for which the circuit breaker will try to recover (as soon as it is in recovering state).

pattern: ^([0-9]+(ns|us|µs|ms|s|m|h)?)+$

responseCode integer

ResponseCode is the status code that the circuit breaker will return while it is in the open state.

minimum: 100

maximum: 599

compress object

Compress holds the compress middleware configuration. This middleware compresses responses before sending them to the client, using gzip, brotli, or zstd compression. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/compress/

defaultEncoding string

DefaultEncoding specifies the default encoding if the `Accept-Encoding` header is not in the request or contains a wildcard (`*`).

encodings []string

Encodings defines the list of supported compression algorithms.

excludedContentTypes []string

ExcludedContentTypes defines the list of content types to compare the Content-Type header of the incoming requests and responses before compressing. `application/grpc` is always excluded.

includedContentTypes []string

IncludedContentTypes defines the list of content types to compare the Content-Type header of the responses before compressing.

minResponseBodyBytes integer

MinResponseBodyBytes defines the minimum amount of bytes a response body must have to be compressed. Default: 1024.

minimum: 0

contentType object

ContentType holds the content-type middleware configuration. This middleware exists to enable the correct behavior until at least the default one can be changed in a future version.

autoDetect boolean

AutoDetect specifies whether to let the `Content-Type` header, if it has not been set by the backend, be automatically set to a value derived from the contents of the response. Deprecated: AutoDetect option is deprecated, Content-Type middleware is only meant to be used to enable the content-type detection, please remove any usage of this option.

digestAuth object

DigestAuth holds the digest auth middleware configuration. This middleware restricts access to your services to known users. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/digestauth/

headerField string

HeaderField defines a header field to store the authenticated user. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/digestauth/#headerfield

realm string

Realm allows the protected resources on a server to be partitioned into a set of protection spaces, each with its own authentication scheme. Default: traefik.

removeHeader boolean

RemoveHeader defines whether to remove the authorization header before forwarding the request to the backend.

secret string

Secret is the name of the referenced Kubernetes Secret containing user credentials.

errors object

ErrorPage holds the custom error middleware configuration. This middleware returns a custom page in lieu of the default, according to configured ranges of HTTP Status codes. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/errorpages/

query string

Query defines the URL for the error page (hosted by service). The {status} variable can be used in order to insert the status code in the URL. The {originalStatus} variable can be used in order to insert the upstream status code in the URL. The {url} variable can be used in order to insert the escaped request URL.

service object

Service defines the reference to a Kubernetes Service that will serve the error page. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/errorpages/#service

healthCheck object

Healthcheck defines health checks for ExternalName services.

followRedirects boolean

FollowRedirects defines whether redirects should be followed during the health check calls. Default: true

headers object

Headers defines custom headers to be sent to the health check endpoint.

hostname string

Hostname defines the value of hostname in the Host header of the health check request.

interval object

Interval defines the frequency of the health check calls for healthy targets. Default: 30s

method string

Method defines the healthcheck method.

mode string

Mode defines the health check mode. If defined to grpc, will use the gRPC health check protocol to probe the server. Default: http

path string

Path defines the server URL path for the health check endpoint.

port integer

Port defines the server URL port for the health check endpoint.

scheme string

Scheme replaces the server URL scheme for the health check endpoint.

status integer

Status defines the expected HTTP status code of the response to the health check request.

timeout object

Timeout defines the maximum duration Traefik will wait for a health check request before considering the server unhealthy. Default: 5s

unhealthyInterval object

UnhealthyInterval defines the frequency of the health check calls for unhealthy targets. When UnhealthyInterval is not defined, it defaults to the Interval value. Default: 30s

kind string

Kind defines the kind of the Service.

enum: Service, TraefikService

name string required

Name defines the name of the referenced Kubernetes Service or TraefikService. The differentiation between the two is specified in the Kind field.

namespace string

Namespace defines the namespace of the referenced Kubernetes Service or TraefikService.

nativeLB boolean

NativeLB controls, when creating the load-balancer, whether the LB's children are directly the pods IPs or if the only child is the Kubernetes Service clusterIP. The Kubernetes Service itself does load-balance to the pods. By default, NativeLB is false.

nodePortLB boolean

NodePortLB controls, when creating the load-balancer, whether the LB's children are directly the nodes internal IPs using the nodePort when the service type is NodePort. It allows services to be reachable when Traefik runs externally from the Kubernetes cluster but within the same network of the nodes. By default, NodePortLB is false.

passHostHeader boolean

PassHostHeader defines whether the client Host header is forwarded to the upstream Kubernetes Service. By default, passHostHeader is true.

passiveHealthCheck object

PassiveHealthCheck defines passive health checks for ExternalName services.

failureWindow object

FailureWindow defines the time window during which the failed attempts must occur for the server to be marked as unhealthy. It also defines for how long the server will be considered unhealthy.

maxFailedAttempts integer

MaxFailedAttempts is the number of consecutive failed attempts allowed within the failure window before marking the server as unhealthy.

port object

Port defines the port of a Kubernetes Service. This can be a reference to a named port.

responseForwarding object

ResponseForwarding defines how Traefik forwards the response from the upstream Kubernetes Service to the client.

flushInterval string

FlushInterval defines the interval, in milliseconds, in between flushes to the client while copying the response body. A negative value means to flush immediately after each write to the client. This configuration is ignored when ReverseProxy recognizes a response as a streaming response; for such responses, writes are flushed to the client immediately. Default: 100ms

scheme string

Scheme defines the scheme to use for the request to the upstream Kubernetes Service. It defaults to https when Kubernetes Service port is 443, http otherwise.

serversTransport string

ServersTransport defines the name of ServersTransport resource to use. It allows to configure the transport between Traefik and your servers. Can only be used on a Kubernetes Service.

sticky object

Sticky defines the sticky sessions configuration. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/load-balancing/service/#sticky-sessions

cookie object

Cookie defines the sticky cookie configuration.

domain string

Domain defines the host to which the cookie will be sent. More info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#domaindomain-value

httpOnly boolean

HTTPOnly defines whether the cookie can be accessed by client-side APIs, such as JavaScript.

maxAge integer

MaxAge defines the number of seconds until the cookie expires. When set to a negative number, the cookie expires immediately. When set to zero, the cookie never expires.

name string

Name defines the Cookie name.

path string

Path defines the path that must exist in the requested URL for the browser to send the Cookie header. When not provided the cookie will be sent on every request to the domain. More info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#pathpath-value

sameSite string

SameSite defines the same site policy. More info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite

enum: none, lax, strict

secure boolean

Secure defines whether the cookie can only be transmitted over an encrypted connection (i.e. HTTPS).

strategy string

Strategy defines the load balancing strategy between the servers. Supported values are: wrr (Weighed round-robin), p2c (Power of two choices), hrw (Highest Random Weight), and leasttime (Least-Time). RoundRobin value is deprecated and supported for backward compatibility.

enum: wrr, p2c, hrw, leasttime, RoundRobin

weight integer

Weight defines the weight and should only be specified when Name references a TraefikService object (and to be precise, one that embeds a Weighted Round Robin).

minimum: 0

status []string

Status defines which status or range of statuses should result in an error page. It can be either a status code as a number (500), as multiple comma-separated numbers (500,502), as ranges by separating two codes with a dash (500-599), or a combination of the two (404,418,500-599).

statusRewrites object

StatusRewrites defines a mapping of status codes that should be returned instead of the original error status codes. For example: "418": 404 or "410-418": 404

forwardAuth object

ForwardAuth holds the forward auth middleware configuration. This middleware delegates the request authentication to a Service. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/forwardauth/

addAuthCookiesToResponse []string

AddAuthCookiesToResponse defines the list of cookies to copy from the authentication server response to the response.

address string

Address defines the authentication server address.

authRequestHeaders []string

AuthRequestHeaders defines the list of the headers to copy from the request to the authentication server. If not set or empty then all request headers are passed.

authResponseHeaders []string

AuthResponseHeaders defines the list of headers to copy from the authentication server response and set on forwarded request, replacing any existing conflicting headers.

authResponseHeadersRegex string

AuthResponseHeadersRegex defines the regex to match headers to copy from the authentication server response and set on forwarded request, after stripping all headers that match the regex. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/forwardauth/#authresponseheadersregex

forwardBody boolean

ForwardBody defines whether to send the request body to the authentication server.

headerField string

HeaderField defines a header field to store the authenticated user. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/forwardauth/#headerfield

maxBodySize integer

MaxBodySize defines the maximum body size in bytes allowed to be forwarded to the authentication server.

format: int64

maxResponseBodySize integer

MaxResponseBodySize defines the maximum body size in bytes allowed in the response from the authentication server.

format: int64

preserveLocationHeader boolean

PreserveLocationHeader defines whether to forward the Location header to the client as is or prefix it with the domain name of the authentication server.

preserveRequestMethod boolean

PreserveRequestMethod defines whether to preserve the original request method while forwarding the request to the authentication server.

tls object

TLS defines the configuration used to secure the connection to the authentication server.

caOptional boolean

Deprecated: TLS client authentication is a server side option (see https://github.com/golang/go/blob/740a490f71d026bb7d2d13cb8fa2d6d6e0572b70/src/crypto/tls/common.go#L634).

caSecret string

CASecret is the name of the referenced Kubernetes Secret containing the CA to validate the server certificate. The CA certificate is extracted from key `tls.ca` or `ca.crt`.

certSecret string

CertSecret is the name of the referenced Kubernetes Secret containing the client certificate. The client certificate is extracted from the keys `tls.crt` and `tls.key`.

insecureSkipVerify boolean

InsecureSkipVerify defines whether the server certificates should be validated.

trustForwardHeader boolean

TrustForwardHeader defines whether to trust (ie: forward) all X-Forwarded-* headers.

grpcWeb object

GrpcWeb holds the gRPC web middleware configuration. This middleware converts a gRPC web request to an HTTP/2 gRPC request.

allowOrigins []string

AllowOrigins is a list of allowable origins. Can also be a wildcard origin "*".

headers object

Headers holds the headers middleware configuration. This middleware manages the requests and responses headers. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/headers/#customrequestheaders

accessControlAllowCredentials boolean

AccessControlAllowCredentials defines whether the request can include user credentials.

accessControlAllowHeaders []string

AccessControlAllowHeaders defines the Access-Control-Request-Headers values sent in preflight response.

accessControlAllowMethods []string

AccessControlAllowMethods defines the Access-Control-Request-Method values sent in preflight response.

accessControlAllowOriginList []string

AccessControlAllowOriginList is a list of allowable origins. Can also be a wildcard origin "*".

accessControlAllowOriginListRegex []string

AccessControlAllowOriginListRegex is a list of allowable origins written following the Regular Expression syntax (https://golang.org/pkg/regexp/).

accessControlExposeHeaders []string

AccessControlExposeHeaders defines the Access-Control-Expose-Headers values sent in preflight response.

accessControlMaxAge integer

AccessControlMaxAge defines the time that a preflight request may be cached.

format: int64

addVaryHeader boolean

AddVaryHeader defines whether the Vary header is automatically added/updated when the AccessControlAllowOriginList is set.

allowedHosts []string

AllowedHosts defines the fully qualified list of allowed domain names.

browserXssFilter boolean

BrowserXSSFilter defines whether to add the X-XSS-Protection header with the value 1; mode=block.

contentSecurityPolicy string

ContentSecurityPolicy defines the Content-Security-Policy header value.

contentSecurityPolicyReportOnly string

ContentSecurityPolicyReportOnly defines the Content-Security-Policy-Report-Only header value.

contentTypeNosniff boolean

ContentTypeNosniff defines whether to add the X-Content-Type-Options header with the nosniff value.

customBrowserXSSValue string

CustomBrowserXSSValue defines the X-XSS-Protection header value. This overrides the BrowserXssFilter option.

customFrameOptionsValue string

CustomFrameOptionsValue defines the X-Frame-Options header value. This overrides the FrameDeny option.

customRequestHeaders object

CustomRequestHeaders defines the header names and values to apply to the request.

customResponseHeaders object

CustomResponseHeaders defines the header names and values to apply to the response.

featurePolicy string

Deprecated: FeaturePolicy option is deprecated, please use PermissionsPolicy instead.

forceSTSHeader boolean

ForceSTSHeader defines whether to add the STS header even when the connection is HTTP.

frameDeny boolean

FrameDeny defines whether to add the X-Frame-Options header with the DENY value.

hostsProxyHeaders []string

HostsProxyHeaders defines the header keys that may hold a proxied hostname value for the request.

isDevelopment boolean

IsDevelopment defines whether to mitigate the unwanted effects of the AllowedHosts, SSL, and STS options when developing. Usually testing takes place using HTTP, not HTTPS, and on localhost, not your production domain. If you would like your development environment to mimic production with complete Host blocking, SSL redirects, and STS headers, leave this as false.

permissionsPolicy string

PermissionsPolicy defines the Permissions-Policy header value. This allows sites to control browser features.

publicKey string

PublicKey is the public key that implements HPKP to prevent MITM attacks with forged certificates.

referrerPolicy string

ReferrerPolicy defines the Referrer-Policy header value. This allows sites to control whether browsers forward the Referer header to other sites.

sslForceHost boolean

Deprecated: SSLForceHost option is deprecated, please use RedirectRegex instead.

sslHost string

Deprecated: SSLHost option is deprecated, please use RedirectRegex instead.

sslProxyHeaders object

SSLProxyHeaders defines the header keys with associated values that would indicate a valid HTTPS request. It can be useful when using other proxies (example: "X-Forwarded-Proto": "https").

sslRedirect boolean

Deprecated: SSLRedirect option is deprecated, please use EntryPoint redirection or RedirectScheme instead.

sslTemporaryRedirect boolean

Deprecated: SSLTemporaryRedirect option is deprecated, please use EntryPoint redirection or RedirectScheme instead.

stsIncludeSubdomains boolean

STSIncludeSubdomains defines whether the includeSubDomains directive is appended to the Strict-Transport-Security header.

stsPreload boolean

STSPreload defines whether the preload flag is appended to the Strict-Transport-Security header.

stsSeconds integer

STSSeconds defines the max-age of the Strict-Transport-Security header. If set to 0, the header is not set.

format: int64

minimum: 0

inFlightReq object

InFlightReq holds the in-flight request middleware configuration. This middleware limits the number of requests being processed and served concurrently. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/inflightreq/

amount integer

Amount defines the maximum amount of allowed simultaneous in-flight request. The middleware responds with HTTP 429 Too Many Requests if there are already amount requests in progress (based on the same sourceCriterion strategy).

format: int64

minimum: 0

sourceCriterion object

SourceCriterion defines what criterion is used to group requests as originating from a common source. If several strategies are defined at the same time, an error will be raised. If none are set, the default is to use the requestHost. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/inflightreq/#sourcecriterion

ipStrategy object

IPStrategy holds the IP strategy configuration used by Traefik to determine the client IP. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/ipallowlist/#ipstrategy

depth integer

Depth tells Traefik to use the X-Forwarded-For header and take the IP located at the depth position (starting from the right).

minimum: 0

excludedIPs []string

ExcludedIPs configures Traefik to scan the X-Forwarded-For header and select the first IP not in the list.

ipv6Subnet integer

IPv6Subnet configures Traefik to consider all IPv6 addresses from the defined subnet as originating from the same IP. Applies to RemoteAddrStrategy and DepthStrategy.

requestHeaderName string

RequestHeaderName defines the name of the header used to group incoming requests.

requestHost boolean

RequestHost defines whether to consider the request Host as the source.

ipAllowList object

IPAllowList holds the IP allowlist middleware configuration. This middleware limits allowed requests based on the client IP. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/ipallowlist/

ipStrategy object

IPStrategy holds the IP strategy configuration used by Traefik to determine the client IP. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/ipallowlist/#ipstrategy

depth integer

Depth tells Traefik to use the X-Forwarded-For header and take the IP located at the depth position (starting from the right).

minimum: 0

excludedIPs []string

ExcludedIPs configures Traefik to scan the X-Forwarded-For header and select the first IP not in the list.

ipv6Subnet integer

IPv6Subnet configures Traefik to consider all IPv6 addresses from the defined subnet as originating from the same IP. Applies to RemoteAddrStrategy and DepthStrategy.

rejectStatusCode integer

RejectStatusCode defines the HTTP status code used for refused requests. If not set, the default is 403 (Forbidden).

sourceRange []string

SourceRange defines the set of allowed IPs (or ranges of allowed IPs by using CIDR notation).

ipWhiteList object

Deprecated: please use IPAllowList instead.

ipStrategy object

IPStrategy holds the IP strategy configuration used by Traefik to determine the client IP. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/ipallowlist/#ipstrategy

depth integer

Depth tells Traefik to use the X-Forwarded-For header and take the IP located at the depth position (starting from the right).

minimum: 0

excludedIPs []string

ExcludedIPs configures Traefik to scan the X-Forwarded-For header and select the first IP not in the list.

ipv6Subnet integer

IPv6Subnet configures Traefik to consider all IPv6 addresses from the defined subnet as originating from the same IP. Applies to RemoteAddrStrategy and DepthStrategy.

sourceRange []string

SourceRange defines the set of allowed IPs (or ranges of allowed IPs by using CIDR notation). Required.

passTLSClientCert object

PassTLSClientCert holds the pass TLS client cert middleware configuration. This middleware adds the selected data from the passed client TLS certificate to a header. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/passtlsclientcert/

info object

Info selects the specific client certificate details you want to add to the X-Forwarded-Tls-Client-Cert-Info header.

issuer object

Issuer defines the client certificate issuer details to add to the X-Forwarded-Tls-Client-Cert-Info header.

commonName boolean

CommonName defines whether to add the organizationalUnit information into the issuer.

country boolean

Country defines whether to add the country information into the issuer.

domainComponent boolean

DomainComponent defines whether to add the domainComponent information into the issuer.

locality boolean

Locality defines whether to add the locality information into the issuer.

organization boolean

Organization defines whether to add the organization information into the issuer.

province boolean

Province defines whether to add the province information into the issuer.

serialNumber boolean

SerialNumber defines whether to add the serialNumber information into the issuer.

notAfter boolean

NotAfter defines whether to add the Not After information from the Validity part.

notBefore boolean

NotBefore defines whether to add the Not Before information from the Validity part.

sans boolean

Sans defines whether to add the Subject Alternative Name information from the Subject Alternative Name part.

serialNumber boolean

SerialNumber defines whether to add the client serialNumber information.

subject object

Subject defines the client certificate subject details to add to the X-Forwarded-Tls-Client-Cert-Info header.

commonName boolean

CommonName defines whether to add the organizationalUnit information into the subject.

country boolean

Country defines whether to add the country information into the subject.

domainComponent boolean

DomainComponent defines whether to add the domainComponent information into the subject.

locality boolean

Locality defines whether to add the locality information into the subject.

organization boolean

Organization defines whether to add the organization information into the subject.

organizationalUnit boolean

OrganizationalUnit defines whether to add the organizationalUnit information into the subject.

province boolean

Province defines whether to add the province information into the subject.

serialNumber boolean

SerialNumber defines whether to add the serialNumber information into the subject.

pem boolean

PEM sets the X-Forwarded-Tls-Client-Cert header with the certificate.

plugin object

Plugin defines the middleware plugin configuration. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/overview/#community-middlewares

rateLimit object

RateLimit holds the rate limit configuration. This middleware ensures that services will receive a fair amount of requests, and allows one to define what fair is. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/ratelimit/

average integer

Average is the maximum rate, by default in requests/s, allowed for the given source. It defaults to 0, which means no rate limiting. The rate is actually defined by dividing Average by Period. So for a rate below 1req/s, one needs to define a Period larger than a second.

format: int64

minimum: 0

burst integer

Burst is the maximum number of requests allowed to arrive in the same arbitrarily small period of time. It defaults to 1.

format: int64

minimum: 0

period object

Period, in combination with Average, defines the actual maximum rate, such as: r = Average / Period. It defaults to a second.

redis object

Redis hold the configs of Redis as bucket in rate limiter.

db integer

DB defines the Redis database that will be selected after connecting to the server.

dialTimeout object

DialTimeout sets the timeout for establishing new connections. Default value is 5 seconds.

pattern: ^([0-9]+(ns|us|µs|ms|s|m|h)?)+$

endpoints []string

Endpoints contains either a single address or a seed list of host:port addresses. Default value is ["localhost:6379"].

maxActiveConns integer

MaxActiveConns defines the maximum number of connections allocated by the pool at a given time. Default value is 0, meaning there is no limit.

minIdleConns integer

MinIdleConns defines the minimum number of idle connections. Default value is 0, and idle connections are not closed by default.

poolSize integer

PoolSize defines the initial number of socket connections. If the pool runs out of available connections, additional ones will be created beyond PoolSize. This can be limited using MaxActiveConns. // Default value is 0, meaning 10 connections per every available CPU as reported by runtime.GOMAXPROCS.

readTimeout object

ReadTimeout defines the timeout for socket read operations. Default value is 3 seconds.

pattern: ^([0-9]+(ns|us|µs|ms|s|m|h)?)+$

secret string

Secret defines the name of the referenced Kubernetes Secret containing Redis credentials.

tls object

TLS defines TLS-specific configurations, including the CA, certificate, and key, which can be provided as a file path or file content.

caSecret string

CASecret is the name of the referenced Kubernetes Secret containing the CA to validate the server certificate. The CA certificate is extracted from key `tls.ca` or `ca.crt`.

certSecret string

CertSecret is the name of the referenced Kubernetes Secret containing the client certificate. The client certificate is extracted from the keys `tls.crt` and `tls.key`.

insecureSkipVerify boolean

InsecureSkipVerify defines whether the server certificates should be validated.

writeTimeout object

WriteTimeout defines the timeout for socket write operations. Default value is 3 seconds.

pattern: ^([0-9]+(ns|us|µs|ms|s|m|h)?)+$

sourceCriterion object

ipStrategy object

IPStrategy holds the IP strategy configuration used by Traefik to determine the client IP. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/ipallowlist/#ipstrategy

depth integer

Depth tells Traefik to use the X-Forwarded-For header and take the IP located at the depth position (starting from the right).

minimum: 0

excludedIPs []string

ExcludedIPs configures Traefik to scan the X-Forwarded-For header and select the first IP not in the list.

ipv6Subnet integer

IPv6Subnet configures Traefik to consider all IPv6 addresses from the defined subnet as originating from the same IP. Applies to RemoteAddrStrategy and DepthStrategy.

requestHeaderName string

RequestHeaderName defines the name of the header used to group incoming requests.

requestHost boolean

RequestHost defines whether to consider the request Host as the source.

redirectRegex object

RedirectRegex holds the redirect regex middleware configuration. This middleware redirects a request using regex matching and replacement. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/redirectregex/#regex

permanent boolean

Permanent defines whether the redirection is permanent (308).

regex string

Regex defines the regex used to match and capture elements from the request URL.

replacement string

Replacement defines how to modify the URL to have the new target URL.

redirectScheme object

RedirectScheme holds the redirect scheme middleware configuration. This middleware redirects requests from a scheme/port to another. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/redirectscheme/

permanent boolean

Permanent defines whether the redirection is permanent. For HTTP GET requests a 301 is returned, otherwise a 308 is returned.

port string

Port defines the port of the new URL.

scheme string

Scheme defines the scheme of the new URL.

replacePath object

ReplacePath holds the replace path middleware configuration. This middleware replaces the path of the request URL and store the original path in an X-Replaced-Path header. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/replacepath/

path string

Path defines the path to use as replacement in the request URL.

replacePathRegex object

ReplacePathRegex holds the replace path regex middleware configuration. This middleware replaces the path of a URL using regex matching and replacement. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/replacepathregex/

regex string

Regex defines the regular expression used to match and capture the path from the request URL.

replacement string

Replacement defines the replacement path format, which can include captured variables.

retry object

Retry holds the retry middleware configuration. This middleware reissues requests a given number of times to a backend server if that server does not reply. As soon as the server answers, the middleware stops retrying, regardless of the response status. More info: https://doc.traefik.io/traefik/v3.6/reference/routing-configuration/http/middlewares/retry/

attempts integer

Attempts defines how many times the request should be retried.

minimum: 0

initialInterval object

InitialInterval defines the first wait time in the exponential backoff series. The maximum interval is calculated as twice the initialInterval. If unspecified, requests will be retried immediately. The value of initialInterval should be provided in seconds or as a valid duration format, see https://pkg.go.dev/time#ParseDuration.

pattern: ^([0-9]+(ns|us|µs|ms|s|m|h)?)+$

stripPrefix object

StripPrefix holds the strip prefix middleware configuration. This middleware removes the specified prefixes from the URL path. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/stripprefix/

forceSlash boolean

Deprecated: ForceSlash option is deprecated, please remove any usage of this option. ForceSlash ensures that the resulting stripped path is not the empty string, by replacing it with / when necessary. Default: true.

prefixes []string

Prefixes defines the prefixes to strip from the request URL.

stripPrefixRegex object

StripPrefixRegex holds the strip prefix regex middleware configuration. This middleware removes the matching prefixes from the URL path. More info: https://doc.traefik.io/traefik/v3.6/middlewares/http/stripprefixregex/

regex []string

Regex defines the regular expression to match the path prefix from the request URL.