How to have custom 404 page in apisix?

[rohitkrishna-marneni]

Is there a plugin which checks the upstream status and if its 404 allows me to provide an url to a custom 404 not found page in apisix?

[dosubot[bot]]

I found a similar open issue where the suggested solution is to implement a plugin to support a custom error page. The error_page directive may not work if ngx.print or ngx.say is used, which is the case when a route is not found ^[1].

In APISIX, you can intercept and modify responses using plugins. Specifically, you can use the header_filter and body_filter functions within a custom plugin to modify the response headers and body. Additionally, the response-rewrite plugin can be configured to modify responses based on specific conditions, such as rewriting the response body or headers when a 404 status code is returned. This allows you to redirect to a custom 404 page or display a custom message.

Here's an example configuration using the response-rewrite plugin:

routes:  
  - upstream_id: 1  
    plugins:  
      response-rewrite:  
        vars: [[ "status","==",404 ]]  
        body: { "error" : "Custom 404 Page Not Found"}

This configuration checks for a 404 status and modifies the response body accordingly. You can adjust the body field to redirect to a custom URL or display a specific message.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}