Error templates don't appear to work

gwshaw · February 1, 2017, 4:04am

I’ve created error templates for 403 and 404 errors as described here:
https://tyk.io/tyk-documentation/customise-tyk/error-templates/
They don’t work. The normal Tyk or Target error content is returned.

Are the docs correct?
Do these templates apply to Tyk errors or to target errors or both?

I’ve changed the text of error.json and that is served up so I know the file mapping is correct (I’m running the Docker quickstart for OSX).

Martin · February 1, 2017, 7:19am

They apply to Tyk errors, errors generated upstream will still remain the proxied version.

gwshaw · February 1, 2017, 7:43am

Ok. They definitely don’t work.

Martin · February 1, 2017, 8:51am

It looks like you are correct, they only work with untracked APIs, I’ve added a backlog ticket:

github.com/TykTechnologies/tyk

Custom error templates only work with APIs that are not tracked

opened 08:48AM - 01 Feb 17 UTC

closed 02:45PM - 15 Nov 17 UTC

lonelycode

bug

**Do you want to request a *feature* or report a *bug*?** bug **What is the …current behavior?** Using a custom error template `error_401.json` does not return the custom error unless the API has `"do_not_track": true` set. **What is the expected behavior?** The gateway should respond with custom errors regardless of the tracking status of the API Definition. **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem** 1. Create a custom error template `error_403.json` in `templates`: ``` { "custom_error": "YOU SHALL NOT PASS!" } ``` 2. Create a new API that uses token authentication 3. Access that API with a non-existent token: ``` curl -X GET -H "Authorization: Foo" -H "Content-Type: application/json" http://10.0.75.2:8181/test/get ``` 4. Check the error that gets returned, it will be the dfault template, not your custom one. **Which versions of Tyk affected by this issue? Did this work in previous versions of Tyk?** 2.2

However modifying the error.json file does work as expected (you need to restart the process).

sairam866 · April 20, 2017, 9:57am

Is the bug still open in v2.3.3?

Kos · April 20, 2017, 10:06am

Hi Sai,

yes, this fix will be part of the v2.4 release.

Thanks,
Kos @ Tyk Support Team