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.

Request Correlation ID

Learn how to use API Connectivity Manager’s Request Correlation ID policy to add a unique identifier to each request entering your app, which you can use to trace end-to-end transactions in a distributed system.

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

Use the Request Correlation ID policy to add a unique identifier to each request that enters an application. With the Correlation ID policy, you can trace end-to-end transactions moving through components in a distributed system. This policy is applied by default and usually uses x-correlation-id as the default HTTP header name. However, you can also provide a custom header value if needed.

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, here’s what you need to do:

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

Policy Settings

Applying the Policy

You can apply this policy using either the web interface or the REST API. The policy uses x-correlation-id as the default HTTP header name, or you can provide a custom header value.

• API
• UI

{
  "policies": {
    "request-correlation-id": [
      {
        "action": {
          "httpHeaderName": "x-correlation-id"
        }
      }
    ]
  }
}