How To
Summary
This technote will provide the steps to define, package and publish a catalog-scoped policy for the API Gateway through the APIM UI instead of using the Datapower WebGUI or a gateway extension.
Objective
Create a catalog-scoped, user-defined policy that can be used in API assemblies within the catalog where the policy is published.
Environment
Applicable to APIC v10.0.5.x and v10.0.8.x LTS and CD releases.
Steps
- First, create a policy yaml with the required or a basic assembly. To make things easier, the assembly can be created from the APIM API Gateway tab and then copied to the policy yaml.
- Structure of the catalog-scoped user-defined policy YAML file
Review the required structure of the YAML file that contains your catalog-scoped user-defined policy.
- Structure of the catalog-scoped user-defined policy YAML file
policy: 1.0.0 info: title: Some Random Policy name: my-policy version: 1.0.0 description: This is a random policy assembly: execute: - invoke: version: 2.0.0 ...Once the policy yaml is complete, create a zip file that contains only the yaml. Both the zip folder and the yaml file will be required to upload to the catalog.
Tip: For the above task on macOS, run the
zipcommand on the command line with the following flags:Including the flags prevents the autogenerated .DS_Store and __MACOSX files from being added to the compressed file.
- Upload the policy to the catalog of choice.
- Manage > Catalog > Catalog Settings > Gateway Services > View Policies for selected gateway > Upload


- Create a new API and navigate to the Gateway Assembly tab.
- The new policy will be available under Integrations. It can be selected and added to the API.
- Note: If you do not see the policy under Integrations, please note that it can sometimes take time to appear or may require a private browser window. If it does not show at all, please open an IBM APIC Support Ticket.
- The new API can now be tested.
Document Location
Worldwide
Was this topic helpful?
Document Information
Modified date:
24 February 2026
UID
ibm17261584