End of Sale Notice:

F5 NGINX is announcing the End of Sale (EoS) for NGINX Management Suite API Connectivity Manager Module, effective January 1, 2024.

F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. License renewals are not available after September 30, 2024.

See our End of Sale announcement for more details.

Error Response Format

Learn how to use the NGINX Management Suite API Connectivity Manager to configure the Error Response Format policy that customizes HTTP error codes and messages.

Overview

In API Connectivity Manager, you can apply global policies to API Gateways and Developer Portals to ensure your organization’s security requirements are enforced.

When you add policies at the environment level, they will apply to all proxies hosted within that environment.

See the Learn about Policies topic for an overview of the different policy types and available policies.

About the Policy

This policy specifies how the API gateway will intercept HTTP errors from the backend(s) and respond to the client with a standard or customized error response in JSON format. The client will receive the Custom Status and Error Message in JSON format, instead of the standard HTTP error coming from the backend. The Error Response Format policy is applied by default to any new environment.

Intended Audience

This guide is meant for Infrastructure Administrators.

Infrastructure Administrators ensure uniform governance across an organization’s infrastructure by setting policies at the infrastructure level, enabling teams to build APIs without interruption while adhering to the organization’s standards.

Workflow for Applying Policy

To apply the policy or make changes to it, follow these steps:

• Edit an existing environment or create a new one.
• Review the advanced settings for the environment to confirm if the policy has been applied.
• Edit the policy to make changes for each environment. Save and publish the changes.

Policy Settings

Note:
Either errorMessage or errorMessageBody must be provided for each error code.

Applying the Policy

You can apply this policy using the web interface or the REST API.

• API
• UI

{
  "policies": {
     "error-response-format": [
        {
           "systemMetadata": {
              "appliedOn": "inbound",
              "context": "global"
           },
           "action": {
              "400": {
                 "errorCode": "13",
                 "errorMessage": "Bad Request"
              }
           }
        }
     ]
  }
}