Skip to main content

ReplacePathRegex

The ReplaceRegex replaces the path of a URL using regex matching and replacement.

The ReplacePathRegex middleware will:

  • Replace the matching path with the specified one.
  • Store the original path in a X-Replaced-Path header.
tip

Regular expressions and replacements can be tested using online tools such as Go Playground or the Regex101.
When defining a regular expression within YAML, any escaped character needs to be escaped twice: example\.com needs to be written as example\\.com.

Configuration Example​

apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
  name: test-replacepathregex
spec:
  replacePathRegex:
    regex: ^/foo/(.*)
    replacement: /bar/$1

Configuration Options​

FieldDescriptionDefaultRequired
regexRegular expression to match and capture the path from the request URL.Yes
replacementReplacement path format, which can include captured variables.
$1x is equivalent to ${1x}, not ${1}x (see Regexp.Expand), so use ${1} syntax.		No