Salesforce Docs Portal

Sync MuleSoft Services into API Catalog

Sync eligible new and updated versions of MuleSoft APIs and MCP servers into your catalog.

Required Editions

Available in: Lightning Experience
Available in: Developer, Enterprise, Performance, and Unlimited Editions
User Permissions Needed
To access API Catalog:

Available to Salesforce admins by default.

For other users, View Setup
To sync MuleSoft services: Customize Application

MuleSoft APIs that meet these criteria are eligible to sync into API Catalog.

  • Are a REST API type
  • Have an sf-api-catalog tag in Anypoint Exchange
  • Have an additional sf-api-topic tag 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.

    For information about configuring APIs to meet these criteria, see MuleSoft Documentation: Add and Remove Asset Tags and MuleSoft Documentation: Add API Instances.

For information about the criteria for syncing MCP servers into API Catalog, see Manage MuleSoft MCP Servers in API Catalog.

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.

A flowchart shows steps in a process: connect orgs, sync, view and search, create connections, assign user permissions, activate actions, use actions.
  1. 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.
  2. From Setup, in the Quick Find box, enter API Catalog, and then select API Catalog.
  3. Click Enable Sync.
    The sync typically takes several minutes to complete, especially for the initial sync, and runs as a background operation.
  4. 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.

Sync API Updates into the Catalog

When you update a synced API specification in Anypoint Platform, API Catalog picks up the updates on the next sync. Whether the sync applies the updates to the schema in Salesforce depends on the type of update and whether any affected components are in use.

The sync automatically applies supported updates to the schema. These are updates to operations that aren't in use and additive updates, such as adding operations, objects, properties, or parameters. However, the sync can’t apply unsupported updates, which are breaking updates to components that are in use. The sync can’t apply updates that remove, rename, or update required properties or parameters that active flows, Apex classes, or agent actions reference. Salesforce doesn't overwrite a schema that active actions depend on.

  1. After the sync completes, check whether the schema updated as expected.

    If the expected update doesn't appear, the update might be an unsupported update. When the sync detects an unsupported update, no error appears in the UI. The sync completes normally but leaves the existing schema unchanged.

    For the full list of supported and unsupported schema updates, see Schema Update Support and Manage External Services.

  2. To apply a breaking schema update, use one of these approaches.

    • Remove the references, then re-sync.

      Update or remove the flows, Apex classes, or agent actions that reference the affected component. Then stop and restart the sync. After the sync, check your integrations for errors caused by the update.

    • Publish the update as a new API version.

      Publish the updated specification in Anypoint Platform as a new asset version. Salesforce treats it as a separate registration with no active operations, so it syncs without affecting integrations that reference the previous version. Publishing a new version is the recommended approach when active flows or Apex classes depend on the affected fields.

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.

  1. From Setup, in the Quick Find box, enter API Catalog, and then select API Catalog.
  2. To start the sync the first time or after you stop it, click Enable Sync on the API Catalog home page.
  3. To stop and restart the sync at any time, click Manage Sync and enable or disable the sync by using the toggle.

See Also