Errors

The errors middleware returns a custom page in lieu of the default, according to configured ranges of HTTP Status codes.

Configuration Examples

Structured (YAML)

# Dynamic Custom Error Page for 5XX Status Code excluding 502 and 504
http:
  middlewares:
    test-errors:
      errors:
        status:
          - "500"
          - "501"
          - "503"
          - "505-599"
        service: error-handler-service
        query: "/{status}.html"

  services:
    # ... definition of the error-handler-service

Structured (TOML)

# Dynamic Custom Error Page for 5XX Status Code excluding 502 and 504
[http.middlewares]
  [http.middlewares.test-errors.errors]
    status = ["500","501","503","505-599"]
    service = "error-handler-service"
    query = "/{status}.html"

[http.services]
  # ... definition of the error-handler-service

Labels

# Dynamic Custom Error Page for 5XX Status Code
labels:
  - "traefik.http.middlewares.test-errors.errors.status=500,501,503,505-599"
  - "traefik.http.middlewares.test-errors.errors.service=error-handler-service"
  - "traefik.http.middlewares.test-errors.errors.query=/{status}.html"

Tags

// Dynamic Custom Error Page for 5XX Status Code excluding 502 and 504
{
  // ...
  "Tags": [
    "traefik.http.middlewares.test-errors.errors.status=500,501,503,505-599",
    "traefik.http.middlewares.test-errors.errors.service=error-handler-service",
    "traefik.http.middlewares.test-errors.errors.query=/{status}.html"
  ]

}

Kubernetes

apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
  name: test-errors
spec:
  errors:
    status:
      - "500"
      - "501"
      - "503"
      - "505-599"
    query: /{status}.html
    service:
      name: error-handler-service
      port: 80

Configuration Options

Field	Description	Default	Required
status	Defines which status or range of statuses should result in an error page. The status code ranges are inclusive (505-599 will trigger with every code between 505 and 599, 505 and 599 included). You can define either a status code as a number (500), as multiple comma-separated numbers (500,502), as ranges by separating two codes with a dash (505-599), or a combination of the two (404,418,505-599).	[]	No
service	The service that will serve the new requested error page. More information here.	""	No
query	The URL for the error page (hosted by service). More information here	""	No

service and HostHeader

By default, the client Host header value is forwarded to the configured error service. To forward the Host value corresponding to the configured error service URL, the passHostHeader option must be set to false.

Kubernetes

When specifying a service in Kubernetes (e.g., in an IngressRoute), you need to reference the name, namespace, and port of your Kubernetes Service resource. For example, my-service.my-namespace@kubernetescrd (or my-service.my-namespace@kubernetescrd:80) ensures that requests go to the correct service and port.

query

There are multiple variables that can be placed in the query option to insert values in the URL.

The table below lists all the available variables and their associated values.

Variable	Value
{status}	The response status code.
{url}	The escaped request URL.