Contact Us 1-800-596-4880

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 for your relevant gateway:

  2. View an API instance’s API Summary for information about the instance or to export it:

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

    • Exporting an API Instance on API Manager - 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 Asset and Developer Portals - 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.

  3. Modify an API instance when you no longer need the instance or when you need to update it:

    • Editing an API Instance - Edit the API instance’s configuration settings to update its base path, port, TLS context, and more.

    • Deprecating an API instance on API Manager - 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 API Instances - You can delete an API instance and its version if you no longer need to manage it from API Manager.

    • Managing API Instance 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.

  4. Explore advanced use cases for API instances:

    • Configure Multiple Client Providers for Client Management - 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.

    • Governing API Instances - You can govern API instances using Anypoint API Governance. View the governance validation report for governed instances to identify conformance issues and take action to fix them.