An API creator blocks subscription to an API as a way of disabling access to it and managing its usage and monetization. A blocking can be temporary or permanent. There is an unblocking facility to allow API invocations back.
You block APIs by subscriptions. That is, if a given user is blocked access to a given API subscribed to using a given application. If a user is subscribed to two APIs using the same application , and you can block access to only one of the APIs only. The user can , s/he can still continue to invoke the other APIs that s/he subscribed to using the same application, or . Also, s/he can continue to access the same API subscribed to using different applications. There is also a unblock facility to allow API invocations back.
Blocking can be done in two levels:
- Block production and sandbox access: API access is blocked with both production and sandbox keys
- Block production access only: Allows sandbox access only. Useful when you wants to fix and test an issue in an API. Rather than blocking all access, you can block production access only, allowing the developer to fix and test.
When API Gateway caching is enabled (it is enabled by default), even after blocking a subscription, consumers might still be able to access APIs until the cache expires, which happens approximately every about 15 minutes.
| Note |
|---|
| Include Page | ||||
|---|---|---|---|---|
|