Versions Compared

Key

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

Display Name

The display name of an the plan must . Must be unique.

Quota Hits

The maximum number of requests that may be sent to an API per monthAPI requests per quota interval. Set to 0 for unlimited quota.

Quota Interval

The quota interval defines the time unit in which the quota hits are available.

Rate Limit

The maximum number of requests that is allowed to hit the API per second.

...

API requests per rate interval. Set to 0 to disable rate limit.

Rate Interval

The rate interval defines the time unit in which the rate limit is available.

Description

A description for this plan. This will be visible in developer portal.

...

Assigning Plans to API Products

In order to subscribe to an API Product, one or more plans must have been previously assigned to it. This can be done within the API.

...

is done in the Plans view of that API Product.

...

Choosing the correct Quota/Rate Intervals

Not all platforms provide native support for all available intervals. When a plan is deployed to a platform that does not natively support a selected interval, the chosen limit will be converted to the closest available interval. This also means that deploying the same plan to multiple platforms may lead to different quota/rate configurations within those platforms.

Take a plan with 100.000 quota hits per week as an example. If the target platform does not support weekly quotas, but supports daily quotas instead, API Control Plane will configure a quota of 14.286 hits per day in that platform.

To avoid these conversions, you should only configure intervals that are natively supported by all your target platforms. The following intervals are natively supported in all platforms:

  • Quota: DAY or MONTH

  • Rate: SECOND