This documentation is for WSO2 API Manager 1.6.0 View documentation for the latest release.
Adding New Throttling Tiers - API Manager 1.6.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

API Manager admins can add new throttling tiers and define extra properties to throttling tiers using the management console as discussed below. For a description of throttling tiers, see API-level throttling.

  1. Log in to the API Manager's Management Console and select Browse under Resources menu.
  2. Select the file: /_system/governance/apimgt/applicationdata/tiers.xml.

  3. In the Contents panel, click Edit as text link and the throttling policy opens.

  4. You can add a new policy configuration by editing the XML code. For example, we have added a new tier called Platinum by including the following XML code block soon after the <throttle:MediatorThrottleAssertion> element.

    Tier DisplayName : You can add this optional attribute to each throttle ID of tiers.xml file in order to decouple the throttle policy name defined in tiers.xml from the tier name showing in APIPublisher/Store UIs. That is, a user can add a different throttle display name to appear in APIPublisher/Store UIs without changing the throttle ID policy name. The configuration below has a displayName as platino for the throttle value platinum. This value is displayed in APIPublisher/Store apps.

    Tier Attributes : In the configuration below, there's a commented out XML section starting from the XML tag <throttle:Attributes>. You can use it to define additional attributes related to each throttling tier definition. For example, if the throttling tier Platinum has attributes called PaymentPlan and Availability, first uncomment the <throttle:Attributes> section and then define the new attributes as follows:

     <throttle:ID throttle:type="ROLE" throttle:displayName="platino">Platinum</throttle:ID>
                   <!--It's possible to define tier level attributes as below for each tier level.For eg:Payment Plan for a tier-->
  5. After the edits, click Save Content. Your new throttling policy (Platinum) is now successfully saved in the Repository used by WSO2 API Manager. You can view this new throttle tier available for selection when creating a new API through the API Publisher.

  • No labels