ingress-nginx-helm/docs/user-guide/custom-errors.md

# 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](https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages) that inspects each request and returns a custom error page with the format expected by the client. Please check the example [custom-errors](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/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
Split documentation 2017-10-13 13:55:03 +00:00			`# 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.

Improve documentation format 2018-04-29 06:17:29 +00:00			`!!! 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.`
Split documentation 2017-10-13 13:55:03 +00:00
Update custom-errors.md Fix grammatical errors 2018-04-27 15:24:05 +00:00			`Using these two headers it's possible to use a custom backend service like [this one](https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages) that inspects each request and returns a custom error page with the format expected by the client. Please check the example [custom-errors](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-errors).`
Split documentation 2017-10-13 13:55:03 +00:00
fix: fix typos in docs. 2017-11-19 17:25:50 +00:00			`NGINX sends additional headers that can be used to build custom response:`
Split documentation 2017-10-13 13:55:03 +00:00
			`- X-Original-URI`
			`- X-Namespace`
			`- X-Ingress-Name`
			`- X-Service-Name`