Create an API Instance

In API Manager 2.x, instances of an API can exist in multiple environments. Additionally, you can create multiple instances of an API in the same environment.

You can create one instance of an API that serves as a proxy. You can create another to manage directly as a basic endpoint. You can apply caching policies (for example, to the proxy), and throttling and security policies to the basic endpoint.

After setting up an API version for management, you repeat the process to create another instance. Attempting to configure the same version creates another instance of the version. You can create multiple instances and expand the version information to view details about them.

Create an API instance

The following procedure describes creating a single API instance from Exchange, and configuring the API instance as an endpoint with proxy:

  1. In API Administration, click Manage API.

  2. Select Manage API From Exchange.

  3. In API name, enter the name of your Exchange asset.

    Once the asset is selected, you can choose the version of the asset to manage.

  4. In API version, select the API version.

  5. In Asset version, select the Exchange asset version.

  6. In Managing type, select Endpoint with proxy.

    If you choose Endpoint with Proxy and do not make an entry (such as accepting the default value), you cannot save your configuration.

  7. In Implementation URI, enter your web site URL or an arbitrary URL, such as

  8. In Client provider, select the client provider to authenticate API access from registered client applications:

    Figure 1. Associate client provider with the API
    • The first item under API Configuration is the Add a Tag field. Tags are optional fields.

    • The second item shows the Managing Type field. Ensure that Endpoint with Proxy is selected.

    • The third item shows the Client provider field.

      If no client providers are configured for your environment and organization, the Client provider field is not visible.

  9. Select a proxy deployment target, for example, CloudHub.

  10. Accept the default path / for the proxy endpoint or enter another path.

  11. In Advanced options, optionally assign an instance label for the proxy (or accept the default label), and set a response timeout.

  12. Click Save.

  13. Click API Administration to return to the API Administration dashboard.


  • Although OpenAPI Specification (OAS) 3.0 is supported, the callback feature is not. To work around this issue, either handle the callback outside of the Mule runtime engine domain or use an OAS 3.0 specification that does not use callbacks.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Give us your feedback!
We want to build the best documentation experience for you!
Help us improve with your feedback.
Take the survey!