Deploy Your API Proxy

You can deploy your API proxy to CloudHub, Runtime Fabric, or a hybrid cloud environment. The resources allocated to the proxy application varies based on the type of proxy you are using. For example, the CloudHub proxy includes a CPU with 0.1 vCores and a memory of 500 MB, by default.

If required, modify the resource allocation from Runtime Manager.


Before you deploy your API proxy, complete the following requirements if you work in a Runtime Fabric or hybrid cloud environment:

  • Runtime Fabric

    • Obtain the Manage APIs Configuration and Deploy API Proxies permissions on your account.

    • Use Mule versions 3.8.7, 3.9.1, 4.1.2, or later.

  • Hybrid:

    • For private servers, obtain access to a Mule runtime engine (Mule) instance configured for your organization.

      For information about how to configure a Mule instance as a server, see register a server in Runtime Manager.

    • Register your private server with a Mule agent that is compatible with your Mule instance.

      For Mule versions 3.8 and later, use Mule Agent 1.9.0. For Mule 4.x, use the Mule Agent specified in the release notes.

Deploy Your API Proxy

Deploy your proxy by completing the following tasks:

Select a Proxy Type

  1. In API Manager, click Add API and select Add new API.

  2. Select Mule Gateway as your runtime.

  3. Select Deploy a proxy application for Proxy type.

Select and Configure a Target Type

  1. Select the Target type from the following options:

    • CloudHub: Select this option if you want to use the Mule runtime hosted on the cloud by MuleSoft. The CloudHub proxy includes a CPU with 0.1 vCores and a memory of 500 MB, by default.

      1. Select the Runtime version.

      2. Enter a Proxy app name.

    • Hybrid: Select Hybrid if you have a Mule runtime running on an on-premises server that you want to use. See Register a server in Runtime Manager for more information.

      If you are running an API with a self-managed server, use the classic API creation flows to manage your API.
      1. Select a target from the list or click Add server.

      2. Enter a Proxy app name.

    • Service Mesh: Select Service Mesh to extend Anypoint Platform API Management capabilities to your Istio service mesh through the deployment of a Mule Adapter.

      After adding the API on Anypoint Platform, you will need to bind it to a service using the Anypoint Service Mesh client. See Methods for Configuring Anypoint Service Mesh for more information.
  2. Click Next.

Select an API

  1. Select an API from the following options:

    • Click Select API from Exchange if you have an API shared with you through Exchange that you want to manage.

      1. Click the API from the list under Select API. You can search for a specific API if needed.

      2. Update the Asset type, API version, and Asset version if needed.

    • Click Create new API.

      1. Enter a name for the new API asset.

      2. Select the Asset type from the following options:

        • REST API: Select this option if you have a RAML or OAS API definition file you want to include for your asset.

          Upload either a RAML or OAS file for your REST API.

        • HTTP API: Select this option if you do not have an API definition file you want to include for your asset.

        • SOAP API: Select this option if you have a WSDL API definition file or an external link to the file.

          Upload a WSDL file for your SOAP API or add the link to the file.

      3. Optionally, you can add an AssetId and customize the Version or API Version details by clicking Advanced.

  2. Click Next.

Configure Options

  1. Enter your Implementation URI.

  2. Click Advanced Options.

  3. Enter the Port number for your API proxy.

  4. In Proxy Version, select latest.
    This value ensures that your API proxy uses the latest released proxy version.

    Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support.
    If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification will be translated to RAML.

  5. If you plan to have HTTPS communications, specify a TLS Context.

  6. Click Next.

Review, Save, and Deploy

  1. Review your selections and edit them if necessary.

  2. If you are ready to deploy, click Save & Deploy. Otherwise, you can select Save, to save the API Instance and deploy it at a later time.

    If you are deploying your API to a Mule 4 environment and want to enable the proxy to support HTTPS requests, first build HTTPS API proxies.

If you deployed your API to a Mule 3 environment, enable HTTPS in Mule 3x.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub