Skip to main content
Feedback

Configuration API Policy Templates

Overview

API policy templates are created in the API Gateway and allow you to group existing API policy configurations under a single named template, with custom descriptions and execution order, so you can apply them consistently across one or more APIs. The API Gateway automatically combines and executes all assigned policies from the template in sequence, while built-in versioning automatically creates a new version whenever the template attached to an API is updated.

API policy templates are discovered automatically in API Control Plane from connected Boomi API Gateway environments, and you can assign templates to APIs.

Prerequisites

  • A Boomi API Gateway environment connected to API Control Plane.
  • API policy templates already defined in Boomi API Gateway. You cannot create or edit templates from API Control Plane. Refer to API Policy Templates for more information on creating API policy templates.

There are two places in API Control Plane that you can view and configure API policy templates: from the API policy templates configuration page or from an API Deployment.

Apply an API policy template from configuration page

For each API that API Control Plane discovers from Boomi API Gateway, you can inspect the API templates and assign the templates to a specified path of an API deployment.

  1. Select Configuration > API Policy Templates. Select an API policy template.

API policy template, table of listed templates

  1. The API policy template details are listed, including a description, version, template ID, and metadata. Select APIs Using Template to view APIs that are using the API policy template.

  2. Select Apply to API Deployment.

  3. Select the Path and Available API Deployment.

  4. Select Apply Policy Template.

API policy template, apply

Configure API policy templates from API deployment

You can view all API deployments and assigned API policy templates from the deployments page. Within the deployment, you can assign or remove API policy templates to or from a specific path, or change which API policy templates are assigned at a specific path.

  1. Select APIs and select the correct API.

  2. Select Deployments. Select the correct deployment.

  3. Select Policy Templates.

  4. You can take the following actions:

    • Assign API policy templates to a specific path. Select the Available Policy Templates dropdown and select the API policy template.
    • Remove API policy templates from a specific path. When you select Remove, it removes the whole path. If you want to remove just one of multiple API policy templates from the path, select Available Policy Templates and remove one by selecting the x on the name of the API policy template.
    • Change which API policy templates are assigned at a specific path.

API policy template, table of listed templates

  1. Select Apply API Policy Templates.
On this Page