Contact Us 1-800-596-4880
  1. Homepage
  2. API Manager (2.x)
  3. Manage API Instances
  4. Add API Instances

  5. Add an Omni Gateway Agent or Tool instance

Adding an Omni Gateway Agent or Tool Instance

Use Omni Gateway for any agent, broker, LLM, or MCP server that needs a flexible and performant gateway that works with distributed and microservices environments and fits into your CI/CD environments.

This diagram shows the upstream and downstream configurations of the instance. In this configuration, the downstream service is the service making requests that are completed by the upstream service. These terms represent the direction of dependency, not the direction of information.

The instance is deployed on a gateway between the upstream and downstream configuration

Add a New Agent or Tool Instance

To add and manage server instances for Omni Gateway, use the Agent and Tool Instances section in API Manager. These server instances can represent Agents, MCP servers, or LLM servers that extend Omni Gateway functionality.

  1. Navigate to Anypoint Platform > API Manager.

  2. Click Agent and Tool Instances.

  3. Click Add and select the protocol: Agent, MCP Server, or LLM.

  4. Select an Omni Gateway to deploy the server instance to from Select a gateway.

    If you don’t see an Omni Gateway listed, or you see an Omni Gateway but its status is Not Running, See Install Omni Gateway and Register and Run in Connected Mode for more information.

  5. Click Next.

  6. Select an instance:

    • Select asset from Exchange: To manage an agent or tool asset shared through Exchange.

      • Select the asset from Select asset. You can also search for an asset.

    • Create a new asset: To create a new asset.

      • In Asset name, enter a name for the new asset.

        Your asset is published to Exchange after it’s protected.

  7. Click Next.

  8. Configure the downstream configuration settings:

    Managed Omni Gateway
    Field Name Description Required Notes

    Base path

    Specifies the URL prefix for all instance paths, relative to the host root. It must start with a leading slash /.

    Yes

    Client provider

    Specifies a client provider for the instance.

    No

    Anypoint Platform acts as the client provider by default. To configure an external client provider, see Client Providers.

    Instance label

    Specifies a label for the instance.

    No

    If you have multiple managed instances of the same asset, add a label to differentiate each instance from the others.

    Advanced Options

    Consumer endpoint

    Specifies a proxy application’s address for consumers to use for sending requests.

    No
    Self-Managed Omni Gateway (Connected Mode)
    Field Name Description Required Notes

    Protocol

    Specifies whether to use HTTP or HTTPS.

    Yes

    If you select HTTPS, specify a TLS context for inbound traffic.

    Inbound TLS

    TLS Context used for the inbound HTTPS traffic.

    No

    Configure a TLS Context for Omni Gateway before adding a TLS Context to your server.

    Port

    Specifies the number to use if the displayed port is incorrect.

    No

    Instances can share the same port across the same target if the Base path is different for both instances.

    Base path

    Specifies the URL prefix for all server paths, relative to the host root. It must start with a leading slash /.

    Yes

    Instance label

    Specifies a label for the instance.

    No

    If you have multiple managed instances of the same asset, add a label to differentiate each instance from the others.

    Advanced Options

    Consumer endpoint

    Specifies a proxy application’s address for consumers to use for sending requests.

    No

  9. Click Next.

  10. Configure one of the server upstream configurations:

    Field Name Description Required Notes

    Upstream URL

    URL to access for the upstream service. This must end with a /.

    Yes

    For example, you can use the URL of your asset in Exchange.

    Outbound TLS

    TLS Context used for the outbound traffic to the upstream service

    No

    Configure a TLS Context for Omni Gateway before adding a TLS Context to your server.

  11. Click Next.

  12. Review your selections and edit them if necessary.

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

    == Edit Agent Network Project Instances

Some instances in Agent and Tool Instances can be created by supplying a YAML file in an agent network project. For instances created with the YAML file, the YAML file is treated as the source of truth. If you edit the instance in API Manager (for example, to add policies), the changes are reverted to the YAML file when the instance is redeployed from the agent network project.

To ensure changes to instances created from a YAML source are present after redeployment, edit the YAML source.

For more information, see Define Your Agent Network.

See Also