Skip to main content
Feedback

Manage policy templates

Use the Policy Templates tab in the Boomi API Management console to create, edit, delete, attach, and assign policy templates across your deployed APIs. For a description of each field and its valid values, refer to Configuration reference.

View policy templates

  1. In the Boomi API Management console, select Configure APIs and Applications.
  2. On the Manage APIs page, click the Policy Templates tab.

The Policy Templates table lists all templates in your account with the following columns:

ColumnDescription
Template NameClickable link to the template detail.
DescriptionFree-text description entered at creation.
VersionThe current version number of the template.
API CountThe number of deployed APIs the template is assigned to.
No Of PoliciesThe number of policy rules included in the template.
ActionThree-dot menu (⋮) with Edit and Delete options.

Use the Search Policy Templates field to filter by name. The table is paginated — use the Items per page dropdown, the page number controls, or the Go to page / Go controls to navigate.

Create a policy template

Before creating a template, ensure the policy rules you want to include already exist in your account. Templates reference existing rules; you cannot create new rules from the template form.

  1. On the Policy Templates tab, click Create Policy Template.

  2. Enter a Template Name (required).

  3. Optionally, enter a Description.

  4. In the Policy Rules section, select one or more policy rules to include:

    • Use the Search Policy Rules field to find rules by name.
    • Select the checkbox next to each rule you want to add. The table shows Policy Name, Execution Timing, Methods, Type, and Configuration.
    • For each selected rule, set the Execution Timing from the dropdown:
      • Before Request And Before Standard Policies
      • Before Request And After Standard Policies
      • After Response and Before Standard Policies
      • After Response and After Standard Policies

    Note: Changing execution timing overrides the individual policy settings.

  5. Click Attach to create the template.

A success notification confirms the template was created. For a description of each field and valid values for Execution Timing, refer to Configuration reference.

Edit a policy template

  1. On the Policy Templates tab, click the (Action) menu next to the template and select Edit.
  2. Update the Template Name, Description, or Policy Rules as needed.
  3. Click Attach to save changes. For field descriptions, refer to Configuration reference.

If the template is currently assigned to one or more APIs, saving creates a new version. The existing version remains active on all currently assigned APIs. After saving, you are prompted to apply the updated version to those APIs.

A success notification such as "Boomi Template - 2.0 Updated Successfully" confirms the update.

Delete a policy template

  1. On the Policy Templates tab, click the (Action) menu next to the template and select Delete.
  2. Confirm the deletion in the dialog.

A success notification such as "'PT 1' Policy Template Deleted Successfully" confirms the deletion.

If the template is currently assigned to one or more APIs, the delete action is blocked. You must unassign the template from all APIs before deleting it.

Attach a policy template to an API

You can attach a policy template from within a deployed API's configuration. This is available only for APIs deployed on a Boomi API Gateway.

  1. Open the deployed API you want to configure.

  2. In the Attach Policies section, click Attach Policy Template.

    If no template is attached, the panel shows: "No policy template is attached to this deployed API. Attach a policy template to continue."

  3. Select the template to attach from the list.

  4. Click Attach.

A success notification such as "2 Policy templates attached to API Successfully" confirms the attachment.

Note: If the API is in read-only mode, attachment is not available. The panel shows: "You cannot attach the Policy Template in read-only mode."

Assign a template to multiple APIs

  1. On the Policy Templates tab, click the template name to open the template detail.
  2. From the template detail, select the APIs to assign the template to (multi-select is supported).
  3. Click Update all APIs.

A success notification such as "2 API's attached to Policy Template 1 Successfully" confirms the bulk assignment.

Unassign a template from an API

  1. Open the deployed API.
  2. In the Attach Policies section, locate the attached template.
  3. From the template's actions menu, select Remove or Detach.
  4. Confirm the action in the dialog.
On this Page