Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Log in to the Admin Dashboard Web application using the URL https://localhost:9443/admin-dashboard and your admin credentials.
  2. Click the Throttling Tiers menu. You will be displayed the existing set of Throttling Tiers. To add a new Tier, click the Add New Tier button.
  3. Fill in the details required by this form and click Save once you are done. 

    Given below is a description of the fields you find in the form:

    FieldDescription
    Request CountThe maximum number of requests allowed to the API within the time period given in the next field.
    Unit TimeTime in seconds within which the the number of requests given in the previous field is allowed to the API.
    Stop On Quota ReachThis indicates the action to be taken when a user goes beyond the allocated quota. If checked, the user's requests will be dropped and an error response (HTTP Status code 429) will be given. If unchecked, the requests will be allowed to pass through.
    Billing PlanThis field only makes sense if you have API Monetization enabled. An API is determined as Free, Commercial or Fremium Freemium depending on the Tiers it has. If all Tiers of an API are tagged as Free, the API will be labelled as a Free API. This labeling happens on the API Store only if monetization has been enabled. Visit this link to find out how to enable Monetization. 
    Custom AttributesCustom attribute values are displayed as key value pairs on the API Store's API Subscription page. The main objective of these fields are to provide more information regarding the Tier to Application Developers at the time API Subscription.
  4. You have added a new API-level throttling tier.

...