Error Page Configuration
Configuration reference for the Error Page plugin (`error-page`): the parameters and plugin metadata, each attribute with its type, whether it is required, its default and its accepted values.
Parameters
This plugin has no configurable parameters when configured on routes and services. All configuration options should be configured using plugin metadata.
See plugin common configurations (opens in Apache APISIX docs) for configuration options available to all plugins.
Plugin Metadata
enable — boolean · optional · default: false · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
If true, enable the plugin.
error_404 — object · optional · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Error page to return when APISIX returns 404 status codes.
body — string · optional · default: Product-specific HTML response · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Response body. The default identifies Apache APISIX or API7 Enterprise Edition, depending on the gateway distribution.
content_type — string · optional · default: text/html · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Response content type.
error_500 — object · optional · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Error page to return when APISIX returns 500 status codes.
body — string · optional · default: Product-specific HTML response · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Response body. The default identifies Apache APISIX or API7 Enterprise Edition, depending on the gateway distribution.
content_type — string · optional · default: text/html · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Response content type.
error_502 — object · optional · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Error page to return when APISIX returns 502 status codes.
body — string · optional · default: Product-specific HTML response · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Response body. The default identifies Apache APISIX or API7 Enterprise Edition, depending on the gateway distribution.
content_type — string · optional · default: text/html · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Response content type.
error_503 — object · optional · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Error page to return when APISIX returns 503 status codes.
body — string · optional · default: Product-specific HTML response · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Response body. The default identifies Apache APISIX or API7 Enterprise Edition, depending on the gateway distribution.
content_type — string · optional · default: text/html · since APISIX 3.17.0 · API7 Gateway 3.2.11.0
Response content type.