Sync MuleSoft APIs into API Catalog
Sync eligible new and updated versions of MuleSoft APIs into your catalog.
Required Editions
| Available in: Lightning Experience |
| Available in: Developer, Enterprise, Performance, and Unlimited Editions |
MuleSoft APIs that meet these criteria are eligible to sync into API Catalog.
- Are a REST API type
- Have an
sf-api-catalogtag in Anypoint Exchange - Have an additional
sf-api-topictag in Anypoint Exchange for APIs with agent or subagent annotations - Have a consumer endpoint for at least one instance, where the
consumer endpoint is a valid HTTPS URL
Consumer URLs appear as destination URLs in API Catalog.
See MuleSoft Documentation: Add and Remove Asset Tags and MuleSoft Documentation: Add API Instances.
API Catalog makes it easy to create secure connections for your MuleSoft APIs. Monitor API versions as they sync into the catalog, request API access, and select SLA tiers directly from the catalog.
- Ask an Anypoint Platform admin to complete the prerequisite configuration in the Anypoint Platform organization you want to sync APIs from. For details, see MuleSoft Documentation: Connecting a Trusted Salesforce Organization to Anypoint Platform.
- From Setup, in the Quick Find box, enter API Catalog, and then select API Catalog.
-
Click Enable Sync.
The sync typically takes several minutes to complete, especially for the initial sync, and runs as a background operation.
-
Make sure the latest synced APIs show in their respective list
by refreshing the page.
If you don’t see the APIs that you expect, double check the prerequisites to sync into the catalog.
If you reach system limits during the sync, remove APIs or API versions that you no longer need. See Remove APIs from API Catalog.
Stop and Restart the API Sync
Stop and restart the sync if necessary. Stop and restart to sync APIs or MCP servers that you just added to Anypoint Platform to avoid waiting for the next scheduled sync. Also consider stopping the sync before creating API Catalog change sets for promotion to other orgs and restarting the sync after you're done.
- From Setup, in the Quick Find box, enter API Catalog, and then select API Catalog.
- To start the sync the first time or after you stop it, click Enable Sync on the API Catalog home page.
- To stop and restart the sync at any time, click Manage Sync and enable or disable the sync by using the toggle.
