/
API Policy Manager Access and Operations

API Policy Manager Access and Operations

In this article

API Policy Manager Asset Support

You can use the API Policy Manager to apply API policies to the following SnapLogic assets.

  • Org: Select the Shared folder under your Org to apply API policies at the Org level (only Org admins have this access).

  • API: Apply API policies at the API level API Manager console.

  • Version: Apply API policies at the version level in the API Manager console. 

  • Project Space: Select the shared folder in your Project Space to apply API policies at the Project Space level in Manager.

  • Project: Select the Project to apply API policies at the Project level in Manager.

Applying Policies at the Org level

Prerequisite: You must be an Org admin to apply policies to the global shared folder.

  1. In Manager, click the shared folder for your Org (also known as the global shared folder), then click Manage API Policy to view the API Policy Manager -shared dialog window, which displays a list of existing API policies and their status.

     

  2. In the API Policy Manager -shared dialog window, click Add Policy to view a list of policies.

  3. Select a policy from the list of policies to open the settings dialog window.

  4. Enter/modify the fields to configure the policy as required, then click Validate and Save.

    The policy settings dialog window closes, and your policy is displayed in the API Policy Manager-shared dialog window.

You can also import and export policies in the API Policy Manager-shared dialog window.

Applying Policies in the API Manager console

You can apply policies at the API and API version level.

Adding API Policies to APIs

  1. In the SnapLogic Manager navigation pane under API Management, click API Manager. 

    Open API Manager

     

    The API Manager page opens.

  2. Click the target API to open the API Details page, and click to display the list of API policies.

  3. Enter or modify the fields as required to configure the policy.

  4. Click Validate and Save.

    The policy settings dialog window closes, and your policy is displayed on the API Details page.

Adding API Policies to API Versions

  1. In the SnapLogic Manager navigation pane under API Management, click API Manager. 

    Open API Manager

    The API Manager page opens.

  2. Click the target API to view the API Details page.

  3. In the API Details page, click the Versions tab, then click the target API version to view the Version Details page.

     

  4. In the Version Details page, click the target to view the API Details page, and click   to display the list of API policies.

  5. Enter or modify the fields as required to configure the policy.

  6. Click Validate and Save.

    The policy settings dialog window closes, and your policy is displayed in the API Details page.

Adding API Policies to Projects and Project Space Shared Folders in Manager

You can apply API policies to the projects and Project Space shared folders that you have access to. Previously, only Org admins could see the Add API Policy option in the dropdown.

For Projects and Project Spaces, all API policies applied at a hierarchy level are automatically applied to all Tasks at that level. For example, an API policy applied at the Project Space level automatically applies to all Tasks within all the Projects inside that Project Space. If the same API policy type is applied at a Project Space and a Project, then the configuration of the lower-level API policy is used. 

 

  1. In Manager, select the target Project Space/Project, click to open the dropdown list, and select Manage API Policy to open the API Policy Manager dialog window.

     

  2. Click Add Policy. A list of all the API policy types appears. 

  3. Click the API policy that you want to add. The settings dialog window for that policy is displayed. 

  4. Enter/modify the field values to configure the policy, then click Validate & Save. The API policy is added to the list of API policies. 

  5. Click Close to close the API Policy Manager dialog.

Enabling/Disabling Policies at the Org and Project Level

  1. Open the API Policy Manager dialog. 

  2. Click the target API policy to open its settings.

  3. Change the value of the Status field. 

  4. Click Validate & Save. You can confirm the Status of the API policy is updated.
    To enable the API policy, repeat steps 2 through 4. 

     

Adding the same API policy type at a lower-level in the hierarchy automatically overrides all API policies of the same type at higher levels. For example, if a Callout Authenticator API policy is added at an Org-level and also at the Project-space-level, the Org-level is automatically overridden as far as the Tasks within that Project Space are concerned.

Viewing Policies for a Task

  1. In Manager, navigate to the target task.

  2. Point the cursor at the target task and click   to open the dropdown, and select Related API Policy.

    The Related Policies dialog window for the target Task is displayed.

  3. Click the Hierarchy tab to open the policy hierarchy.

Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2025 SnapLogic, Inc.