Managing API Instances

An API instance is the instantiation of an API definition. It is an object that is used to share data between gateways and the control plane. An API Instance can either be a proxy of an API that serves the upstream or a Mule application endpoint.

You can create, import, and deprecate API instances using API Manager. You can use instances of an API in multiple environments. You can also have multiple instances of an API in the same environment.

You can create one instance of an API version that serves as a proxy and create another to directly manage it as an endpoint. You can apply policies to the API based on how the API is configured—​proxy or endpoint. For example, you can apply caching policies to the proxy, and throttling policies and security policies to the endpoint. Additionally, you can promote an API to another environment.

To manage API Instances in API Manager:

  1. Add an API Instance - API instances are managed by API Manager after you add them and remain under management until you delete them.

  2. Configure an API Instance - You can customize your API Instance to fit your specific situation with many optional settings. Not all options are available depending on the runtime as well as the API.

  3. View an API Instance’s settings for information about the instance or to export it.

    • Obtain API Instance ID - API Manager generates the apiId of new APIs managed by API Manager for use with Mule 4.

    • Export an API Instance - After creating an API instance, you can export it. This exports the API instance endpoint configuration and Exchange asset relationship. You can then import it into another environment in the same business group to create a new API instance.

    • Access the Developer Portal - As an administrator, you can view the resources and methods of an API, and access other details, such as publish date and mocking service, from Anypoint Exchange (Exchange). You can view the API in an asset portal (private) or a public portal.

  4. Modify an API Instance when you no longer need the instance or when you need to update it to the latest version.

    • Deprecate an API Instance - While transitioning consumers of your API to an updated instance, you can prevent developers from signing up for access to your old API instance.

    • Delete an API Instance - You can delete an API instance and its version if you no longer need to manage it from API Manager.

    • Manage API Versions - After you create an API in Anypoint Platform, you configure the version details for the API and then publish it to Anypoint Exchange (Exchange). The API version resides in Exchange, and not in API Manager. However, you then manage this API version from API Manager.

  5. Explore advanced use cases for API Instances.

    Configure Multiple Client Providers - You can use multiple client providers, such as OpenAM and PingFederate, to help you enforce security and regulations in your business organization. These client providers enable you to secure your operational data, including client credentials and access tokens.

Was this article helpful? Thanks for your feedback!
View on GitHub