Configuring an API Endpoint in API Manager

How you configure your API endpoint to manage application requests depends on the relationship between your Mule application and your API:

  • Basic API endpoint configuration

    Use this option to directly interact with a Mule runtime Engine (Mule) application when your application is configured with API gateway autodiscovery.

  • Proxy API endpoint configuration

    Use this option to interact by proxy with an application, either because it is a Mule application not configured with API gateway autodiscovery or because it is not a Mule application.

To configure your API endpoint:

  1. In API Manager, select the instance of the API for which you want to configure an endpoint.

    Create and configure an API Endpoint
    Figure 1. The screen capture shows how to create and configure an endpoint for the selected API.
    1 A tag for the API endpoint
    2 The endpoint type: basic or proxy
    3 The client provider, if you have configured an external client provider

  2. Scroll to the bottom of the page to the API Configuration section.

  3. In the Managing Type field, select the endpoint type:

    • Basic Endpoint

    • Endpoint With Proxy

      You can accept the default Path / for the proxy endpoint or enter another path.

  4. If you are configuring a Basic Endpoint, perform the following steps:

    1. In the Application type section, specify whether your application uses a Hybrid or CloudHub environment, or if you are running a non-Mule application managed by Anypoint Service Mesh.

    2. If you want to manage the API using Mule 4 or later (recommended), accept the default selection.

      The parameters that you specify differ based on the Mule version you select.

    3. If you are creating the endpoint with proxy, in the Implementation URI field, specify the URL of the site that hosts the API, for example, http://product.mydomain.com.

      Otherwise, you can skip this step.

  5. If you are configuring an Endpoint With Proxy, perform the following steps:

    Create API endpoint with proxy
    Figure 2. The screen capture shows how to create and configure an endpoint for the selected API.
    1 The application type: CloudHub, Hybrid, or non-Mule application managed by Anypoint Service Mesh
    2 The Add TLS context option
    3 The Advanced options

    1. In the Proxy deployment target section, specify whether the proxy deployment target is a CloudHub or a Hybrid installation. Choose Hybrid if you are managing servers.

    2. Select the Mule version box if you want to manage APIs in Mule 4 or later.

    3. If you are creating the endpoint with proxy, in the Implementation URI field, specify the URL of the site that hosts the API, for example, http://product.mydomain.com.

      Otherwise, you can skip this step.

    4. In the TLS Context for outbound traffic field, click Add TLS Context and specify the TLS context to secure outbound traffic.

    5. In Path, specify the path.

    6. Click Advanced options to specify additional settings.

      1. From Proxy version, choose the proxy version that you are currently using.

      2. If you want to expose and test your API specification using API Console, select Enable Console and optionally specify a different path in Console Path, for example, "/spec/*".

      3. In Validations, select the box if you want to validate inbound requests against a specification.

        You can optionally specify the use of query parameters for strict validations.

      4. In Scheme, specify whether you want to use an HTTP or an HTTPs schema.

      5. In API instance label, specify a label for the API.

      6. In Port, specify the port number to use for the requests.

        8081 is the default port number. You can modify this port number, if required.

      7. Optionally, in Response timeout, specify the time (in milliseconds) after which the response must time out.

      8. Optionally, from Client provider, select the identity provider (IdP) that you want to use to authenticate access to this API from registered client applications.

        If no client providers are set up for your environment and organization, this field is not visible.

  6. Optionally, scroll up to API Configuration and click ADD A TAG to enter a tag name (for example: Released) to display the status of an API version to users.

  7. Click Save.

See Also

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub