Error Page Configuration

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 for configuration options available to all plugins.

Plugin Metadata

• enable — boolean · optional · default: false

  If true, enable the plugin.

• error_404 — object · optional

  Error page to return when APISIX returns 404 status codes.

  • body — string · optional · default: Product-specific HTML response

    Response body. The default identifies Apache APISIX or API7 Enterprise Edition, depending on the gateway distribution.

  • content_type — string · optional · default: text/html

    Response content type.

• error_500 — object · optional

  Error page to return when APISIX returns 500 status codes.

  • body — string · optional · default: Product-specific HTML response

    Response body. The default identifies Apache APISIX or API7 Enterprise Edition, depending on the gateway distribution.

  • content_type — string · optional · default: text/html

    Response content type.

• error_502 — object · optional

  Error page to return when APISIX returns 502 status codes.

  • body — string · optional · default: Product-specific HTML response

    Response body. The default identifies Apache APISIX or API7 Enterprise Edition, depending on the gateway distribution.

  • content_type — string · optional · default: text/html

    Response content type.

• error_503 — object · optional

  Error page to return when APISIX returns 503 status codes.

  • body — string · optional · default: Product-specific HTML response

    Response body. The default identifies Apache APISIX or API7 Enterprise Edition, depending on the gateway distribution.

  • content_type — string · optional · default: text/html

    Response content type.