Skip to content

Creating a policy (w/edit and delete)

In this guide, you’ll learn how to create a Gateway Policy. Creating and attaching a gateway policy to an API allows you to apply granular control over the API Requests. Visit Gateway Policies to learn more.

By following the below sections, you can create a gateway policy as well as edit and delete it.

Info

Before you proceed with the following instructions, ensure you’re a user with the platform-admin, api-product-manager role.

Steps to create a policy

From the home screen of your API Manager account, go to Gateway Control → Gateway Policies.

Then, in the window that opens:

  • Click Create Policy
  • A new Create Gateway Policy window will open. Here, you need to:
  • Select the Control level: Subscription Level or API Level
  • Select a Policy type:
    • If Subscription Level: Blacklist IP Address | Whitelist IP Address | Throttling | Message Signature | Transformation | mTLS Configuration | Encryption & Decryption | Verify Headers | Custom Plugin | Monetization Limit Check | JSON Threat Protection | XML Threat Protection | Regex Threat Protection | Raise Fault
    • If API Level: Advance Routing | Load Balancing | Transformation | Mock API Response | Caching | CORS - Cross Origin Resource Sharing | Encryption & Decryption | Verify Headers | Schema Validation | Payload Capture | Custom Plugin | JSON Threat Protection | XML Threat Protection | Regex Threat Protection | API Quota Check | Raise Fault
  • Enter the Policy name
  • Enter the Description
  • Provide the required policy details for the selected type
  • Once you complete all the fields for the appropriate policy type, click Create policy
  • The policy will be created and added to the list

Info

Fields with asterisk (*) are mandatory.

Viewing a policy

To open a policy in read-only mode:

  • From Gateway Control → Gateway Policies, find the policy in the list.
  • In the View column, click the view icon.
  • The View gateway policy window opens with the policy fields in read-only mode.
  • To switch to edit mode from this window, click Edit.
  • To leave without editing, click Close.

Edit a policy

In order to edit a policy:

  • Click for the policy you need to edit.
  • Then, make changes in the popup shown.
  • Once done, click Update.

Editing a Gateway Policy

Deleting a policy

To delete a policy:

  • Simply click the for the policy you need to delete.
  • Then, click Delete to confirm the action.

Deleting a Gateway Policy

This will delete the policy. However, before you do that, ensure deleting it won’t affect any present API(s).