Skip to main content

Onboard an API with MuleSoft API Gateway

Prerequisites​

Create a Connected App in the MuleSoft API Gateway (Anypoint)​

  • Log in to https://anypoint.mulesoft.com/

  • Visit Access Management Access Management in Anypoint

  • Click Connected Apps Connected Apps option

  • Click Create App Create App button

  • Enter App name App name field

  • Select App is of type App acts on its own behalf (client credentials) App type selection

  • Click Add Scopes Add Scopes button

  • Assign the required scopes/permissions in the Connected App and click Next

    • API Governance → Governance Viewer
    • API Manager → View APIs Configuration
    • Data Gateway → Data Gateway Viewer

    Scopes list

  • Select Business Groups for the scopes you choose to control which teams or organizational units have access to specific API permissions and click Next Business Groups selection

  • Select the Environments to deploy or manage an API, ensuring proper separation and control across development, testing, and production stages and click Next Environments selection

  • Review the scopes/permissions and click Add Scopes Review scopes

  • Click Save Save button

  • Retrieve the Client ID and Client Secret from the Connected App. Client ID and Client Secret

MuleSoft Gateway integration with the APIsec product​

Start adding a new application​

Select MuleSoft Gateway​

  • Choose the MuleSoft Gateway option.

    Choose the MuleSoft Gateway

Enter application details​

  • If existing connections are available, they will be displayed in the Connections list. To create a new connection, click New Connection.

  • If no connections exist, a connection form is displayed, allowing you to enter the required details and create a connection.

    New Connection option

  • Fill in the form with Name, Id, and Secret. MuleSoft connection form

  • Click Test Connection Test Connection button

  • Test Connection Success Connection test success message

  • Click Create Connection Create Connection button

  • Select Business Group and Environment, then select the correct API Select Business Group, Environment, and API

  • Click Continue Continue button

  • API Registered Successfully API registered message

  • Select Endpoints Select endpoints

  • Click Onboard Onboard button

  • MuleSoft API Integrations Application Dashboard MuleSoft application dashboard


Auto-Onboard​

The Auto-Onboard feature streamlines API onboarding by automatically detecting and registering unregistered APIs from MuleSoft Gateway. This ensures that all APIs, including newly published ones, are consistently onboarded and tested for vulnerabilities with minimal manual effort.

Enable Auto-Onboard​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Mulesoft

    Onboard Applications for Mulesoft

  • Enable Auto-Onboard of any existing Mulesoft connection.

    Auto-Onboard toggle

  • Fill in the Mulesoft AutoOnboard Details and click Save Schedule

    • Frequency – How often the onboarding should occur. By default it is weekly.
    • Day of the Week – Select the specific day for onboarding.
    • Hour – The exact time (in hours and minutes) when the onboarding should start.
    • Timezone – The timezone in which the schedule should be applied
    • Business Group - Select Business Group
    • Environment - Select Environment

    Mulesoft AutoOnboard details and Save Schedule button

    • Successfully saved auto-onboard details

    Auto-onboard saved confirmation

Update Schedule​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Mulesoft

    Onboard Applications for Mulesoft

  • Click Auto-Onboard enabled toggle

    Auto-Onboard enabled toggle

  • Update the details and click Update Schedule

    Update Schedule button

Disable Auto-Onboard​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Mulesoft

    Onboard Applications for Mulesoft

  • Click Auto-Onboard enabled toggle

    Auto-Onboard enabled toggle

  • In Edit Mulesoft AutoOnboard Details, disable the Enable Automatic API Onboarding.

    Disable automatic API onboarding

  • Click Yes to confirm Confirmation dialog

  • Auto-Onboard details deleted.

    Auto-Onboard details deleted message

Edit MuleSoft connection​

To edit the MuleSoft connection

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Mulesoft

    Onboard Applications for Mulesoft

  • A list of existing Mulesoft connections is displayed.

    Mulesoft connections list

  • Select the Pencil icon next to the connection you want to edit.

    Pencil icon next to a connection

  • Update the required details and click Test Connection

    Test Connection button

  • Once the connection test succeeds, click Update Connection

    Update Connection button

  • The updated connection is now displayed in the connections list.

    Updated connections list

Delete MuleSoft connection​

To delete the MuleSoft connection

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Mulesoft

    Onboard Applications for Mulesoft

  • A list of existing Mulesoft connections is displayed.

    Mulesoft connections list

  • Select the Delete icon next to the connection you want to delete.

    Delete icon next to a connection

  • Click Delete to confirm

    Delete confirmation dialog

  • The deleted connection is no longer displayed in the connections list.

    Connections list after deletion