salesforce Say hello to Einstein GPT
Contact Us 1-800-596-4880
  1. Homepage
  2. API Manager
  3. Configure API Proxies

  4. Deploy an API Proxy

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.

Prerequisites

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:

  1. Select Proxy Type

  2. Select and Configure Proxy Type

  3. Select an API

  4. Configure Options

  5. Review, Save, and Deploy

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.

    • CloudHub 2.0: Select this option if you want to use the Mule runtime hosted by MuleSoft in a container-based cloud infrastructure. The CloudHub 2.0 proxy includes a CPU with 0.1 vCores by default.

      1. Select the Runtime version.

      2. Enter a Proxy app name.

    • 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.

    • Runtime Fabric: Select Runtime Fabric if you want to deploy API Proxies to a Mule runtime engine that is managed on Runtime Fabric. See Deploying API Proxies to Runtime Fabric for more information.

      1. Select a target from the list.

      2. Select the Runtime version.

      3. Enter a Proxy app name.

  4. 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.
          This option is not available for Flex Gateway runtime at this time.

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

  5. Click Next.

Configure Options

  1. Enter your Implementation URI. The Implementation URI is the URL to access the proxy or the API. For example, you can use the URL of your API asset in Exchange.
    This is the only required field. For further details on the optional fields, see Configure an API Endpoint.

  2. If you want to enable SSL for inbound traffic:

    • Select HTTPS for the Scheme.
      You should now see the TLS Context for Inbound Traffic field enabled.

    • Select Add TLS Context.

      • Select the secret group where you hosted your TLS context from the Secret group drop-down.

      • Select your TLS context for your HTTPS API Proxy from the TLS Context drop-down.

  3. Enter the Port number for your API proxy.

  4. Select your Client Provider.

  5. Click Advanced Options.

  6. In Proxy Version, select latest.
    This value ensures that your API proxy uses the latest released proxy version. If a new proxy version is available in Anypoint platform, return to this step to reconfigure your proxy to the latest version.

  7. Click Add TLS Context for TLS Context for Outbound traffic.

    1. Select the secret group where you hosted your TLS Context from the Secret Group drop-down list.

    2. Select your TLS Context for your HTTPS API Proxy from the TLS Context drop-down.

      If you can’t see a context, check that you have the right permissions, as mentioned in [Before You Begin].

  8. Click Next.

    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.

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

  10. Click Next.

  11. Review your selections and edit them if necessary.

  12. 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.

See Also

View on GitHub