Applying a Policy Template on the API Details Page

Edit online

Before you begin

You must have the API Gateway's manage APIs functional privilege assigned.

About this task

The Policies tab on the API details page specifies the set of policies that API Gateway will execute when an application requests access to that particular API.

The API can have a set of policies that are applied through a global policy, through a policy template, through a scope-level policy, and through API-level policies.

To customize the policy configurations for an API using a policy template, you need to apply the template (containing a set of policies), and then configure the properties of the individual policies to suit the runtime requirements for that API.

To apply a policy template on the API details page

Procedure

  1. Click APIs in the title navigation bar.
    A list of all registered APIs appears.
  2. Select the required API.
  3. Click Edit.
  4. Click the Policies tab.
    The API's policy information is provided in the following sections:
    • Policy stages - Threat Protection, Transport, Identify and Access, Request Processing, Routing, Traffic Monitoring, Response Processing, Error Handling
    • Infographic - List of applied policies
    • Policy properties - Collection of policy properties
  5. Click Apply template located in the lower right-corner of the Infographic section.
    This opens the Apply template dialog box.
  6. In the Template chooser, select one or more policy templates that you want to apply to the API.
    You can choose to display the details of an individual policy template by clicking the Info icon. This option populates the list of policies that are defined in the particular template.
  7. Select one or more policy templates that you want API Gateway to execute at run-time.
  8. Click Next.
    You must have at least one template selected to use the Next button.
  9. In the Apply Templates to API wizard, review the list of policies and the configuration details of the associated policies.
    • If necessary, you can click Previous to return to the Template chooser wizard and change your template selections.
    • If at any time you wish to abandon all your changes and return to the Policies tab, click Cancel.
  10. Click Apply.
    If you have one or more policy conflicts, API Gateway displays the conflicting/incompatible policies with a Conflict icon. You can choose to resolve the policy conflicts and do a Apply, or simply continue to Apply with conflicts.

    If you choose the continue with conflicts, API Gateway sets the focus on the conflicting policies with Conflict () icon displayed next to the policy names in the Infographic section and the corresponding policy stages.

    API Gateway will redirect you to the Policies tab. The newly applied policy template comprising a set of policies and the policy properties is displayed in the Infographic section.
  11. After you apply the required policy templates, click Save to save the updated API.

What to do next

Post-requisites:

Activate the API when you are ready to put it into effect.