Auto-Discovery Reference (Mule 4)

The api-platform-gw gateway global element contains the information needed to register an API in Anypoint Platform. The global element includes the description and tag attributes. The api-platform-gw attributes include the flowRef attribute. In an APIkit project, the global element includes an apikitRef that references the APIkit global configuration.

API Manager 2.x doesn’t support the create attribute. You need to create an API in API Manager before using auto-discovery.

The following table lists the api-platform-gw attributes when you use API Manager 2.x and Mule 4:

Attribute Required Description



The friendly API name that appears on API Manager and in Studio on Global Element Properties.



A reference to the main flow of your project. It triggers the agent to discover this flow and use it when performing the auto-registration.



A reference to the APIkit configuration. Used to upload the RAML file to Anypoint Platform after API registration completes and for resource level policies.

API Manager generates the apiId of new APIs managed by API Manager. The API ID is displayed on the API instance dashboard:

api id

The following configuration.xml is an example of an API configured for auto-discovery in Mule Runtime 4.x:

Mule Runtime 4.x

<api-gateway:autodiscovery apiId="${}" flowRef="proxy" doc:name="API Autodiscovery"/>

In Mule Runtime 4.x, create, apikitRef attributes and description, tag elements were removed.

api-platform-gw Nested Elements

The following attributes list the api-platform-gw nested elements.

Nested Element Required Description



A description of the API that appears on the API version details page when Anypoint Platform discovers and registers the API.



The tag is searchable metadata in the API Manager and API that appears on the API version details page when Anypoint Platform discovers and registers the API.

Auto-Discovery Namespace, Schema, and Dependency Information


Auto-Discovery Dependency Information