Configure Policies

Learn how to use NGINX Management Suite API Connectivity Manager to configure policies for your API Gateway and Developer Portal clusters and API Proxies.

Overview

In NGINX Management Suite API Connectivity Manager (ACM), you can apply global policies to API Gateway and Developer Portal clusters 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.

Before You Begin

Complete the following prerequisites before proceeding with this guide:

  • API Connectivity Manager is installed, licensed, and running.
  • You have one or more Environments with API Gateway or Dev Portal clusters.

How to Access the User Interface

This guide contains instructions for completing tasks by using the NGINX Management Suite API Connectivity Manager user interface (UI).

To access the UI, navigate to the FQDN for your NGINX Management Suite host and log in. Then, select “API Connectivity Manager” on the Launchpad menu.

Configure Global Policies

Global Policies are configured at the Environment level and apply to all Clusters and Proxies within the Environment.

The table below shows the policies that are applied by default when you create a new cluster.

Cluster Type Default(s)
API Gateway Error Response Format
Log Format
Proxy Response Headers
Request Body Size Limit
Request Correlation ID
Dev Portal Proxy Response Headers

To manage Global Policies, take the steps below:

  1. In the ACM user interface, go to Infrastructure > Workspaces > Environments.
  2. Select the Environment that holds the cluster that you want to configure, then select the Cluster name.
  3. Select the Manage icon for the cluster that you want to configure.
  4. Select the Global Policies tab.
  5. Add, Edit, or Remove as desired.
  6. Save and Submit your changes.

Add a Policy

Take the steps in this section to add a new policy to a cluster.

  1. Go to Manage > Global Policies for the cluster.
  2. Select Add Policy from the policy’s Actions menu.
  3. Complete the form provided to configure the policy, then select Add.
  4. Save and Submit your changes.

Edit a Policy

To edit a policy, take the steps below.

  1. Go to Manage > Global Policies for the cluster.
  2. Select Edit Policy from the policy’s Actions menu.
  3. Edit the policy as needed.
  4. Select Save and Save and Submit.

Remove a Policy

To remove a policy, take the steps below.

  1. Go to the Global Policies tab for the cluster.
  2. Select Remove Policy from the policy’s Actions menu.

Configure Proxy Policies

Any Global Policies will automatically be applied when you add an API Proxy. You can also configure any of the optional policies at the proxy level.

To manage Proxy Policies, take the steps below.

  1. In the ACM user interface, go to Services > Workspaces > Proxies.
  2. Select Edit Proxy from the Actions menu for the Proxy that you want to configure.
  3. Select the Policies tab.
  4. Add, Edit, or Remove as desired.
  5. Save and Publish your changes.

Add a Policy

Take the steps in this section to add a new policy to a cluster.

  1. Go to Edit Proxy > Policies.
  2. Select Add Policy from the policy’s Actions menu.
  3. Complete the form to configure the policy, then select the Add button.
  4. Save and Submit your changes.

Edit a Policy

Take the steps below to edit a policy.

  1. Go to Edit Proxy > Policies.
  2. Select Edit Policy from the policy’s Actions menu.
  3. Edit the policy as needed.
  4. Select Save, then Save and Publish.

Remove a Policy

To remove a policy, take the steps below.

  1. Go to Edit Proxy > Policies.
  2. Select Remove Policy from the policy’s Actions menu.