ingress-nginx-helm/docs/user-guide/custom-errors.md
Sam Fleming ce9d42b52d
Update custom-errors.md
Fix grammatical errors
2018-04-27 16:24:05 +01:00

997 B

Custom errors

In case of an error in a request the body of the response is obtained from the default backend. Each request to the default backend includes two headers:

  • X-Code indicates the HTTP code to be returned to the client.
  • X-Format the value of the Accept header.

Important: The custom backend must return the correct HTTP status code to be returned. NGINX does not change the response from the custom default backend.

Using these two headers it's possible to use a custom backend service like this one that inspects each request and returns a custom error page with the format expected by the client. Please check the example custom-errors.

NGINX sends additional headers that can be used to build custom response:

  • X-Original-URI
  • X-Namespace
  • X-Ingress-Name
  • X-Service-Name