Contact Us 1-800-596-4880
  1. Homepage
  2. API Manager (2.x)

  3. Manage API Instances

Managing Instances

An instance is the instantiation of a definition, such as an API or another component. It is an object that shares data between gateways and the control plane. Depending on its type, an instance can represent a proxy that serves upstream traffic, a Mule application endpoint, or another managed component (for example, a broker, agent, or LLM).

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

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

To manage instances in API Manager:

  1. Add an instance for your relevant gateway:

  2. View an instance’s summary for information 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 instance, you can export it. This exports the instance configuration and Exchange asset relationship. You can then import it into another environment in the same business group to create a new instance.

    • Access Asset and Developer Portals - As an administrator, you can view 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 a private asset portal or a public portal.

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

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

    • Deprecating an API instance on API Manager - While transitioning consumers to an updated instance, you can prevent developers from signing up for access to the old instance.

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

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

  4. Explore advanced use cases for instances:

    • Configure Multiple Client Providers for Client Management - You can use multiple client providers, such as OpenAM and PingFederate, to help 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 instances using Anypoint API Governance. View the governance validation report for governed instances to identify conformance issues and take action to fix them.