Policies
These are used to control various aspects of an API when presented to the public for consumption - through the Find and Use an API Consumption Portal. Policies are grouped into different scopes as indicated with the presentation of the Policies page.
- API scope - Policy is applied at the API level
- Environment scope - Policy is applied to a specific API environment (Dev, Staging or Live)
- Operation scope - Policy is applied and affects only a specific operation. For example, GET method where the policy will only affect retrieving information operation using the API.
You can combine these policies into complex scopes that are broad or narrow in changing the behavour of a published API. For example, you can setup policy scopes that cover a specific API, all environment and only a specific operation.
Policies are optional when publishing your API. This means you can add policies for the different scopes, environments or none. Additionally, it is worth noting that each policy inherits from the policy scope above. This means Operations scope inherits from the Environments scope and the Environments scope inherits from the API scope.
Within the Policies page, you can do the following conveniently grouped within the relevant scope: