Deployment: Invicti Platform on-demand, Invicti Platform on-premises
IBM API Connect
Integrating IBM API Connect SaaS with Invicti Platform allows you to discover and import published API specifications directly from your IBM API Connect environment. The imported specifications are used to build an inventory of API endpoints in your Invicti API catalog, ready to be scanned for vulnerabilities.
This document explains how to set up an integration between Invicti Platform and IBM API Connect.
Why this matters
Manually uploading API specifications is time-consuming and error-prone when your API landscape changes frequently. Connecting Invicti directly to IBM API Connect keeps your API inventory up to date automatically, so every published API is available for scanning without requiring manual intervention each time a new API is added or updated.
Prerequisites
To integrate IBM API Connect SaaS with Invicti Platform, you need an IBM API Connect SaaS account. Before you begin, have the following values ready from your IBM API Connect instance:
- Platform API endpoint - the base URL for the IBM API Connect platform API (for example,
https://platform-api.trial.apiconnect.automation.ibm.com) - Client ID - the platform API client ID
- Client secret - the platform API client secret
- API key - the platform REST API key
Refer to the IBM API Connect documentation for how to obtain these values.
Only Swagger2 and OpenAPI3 specification files are imported.
Step 1: Configure the API import source in Invicti Platform
The configuration in Invicti is a two-step wizard: source details followed by connection details.
Source details
- Select Discovery > API sources from the left-side menu.
- Click Add source.
- Enter a name for the source configuration to help you identify it later in your list of API sources.
- Under Exclude empty specifications, select Yes to skip APIs that don't have defined operations, or No to import all APIs regardless.
- Under Source type, select IBM API Connect from the API gateway section.
- Click Continue.
Connection details
- Enter the Platform API endpoint - the base URL for the IBM API Connect platform API (for example,
https://platform-api.trial.apiconnect.automation.ibm.com). - Enter the Client ID from IBM API Connect.
- Enter the Client secret from IBM API Connect.
- Enter the API key - the platform REST API key from IBM API Connect.
- Click Save profile.
Your IBM API Connect integration is now listed on the Discovery > API sources page.
Step 2: Synchronize the API import
-
On the Discovery > API sources page, click the sync icon next to your IBM API Connect source to start importing API specification files into your Invicti API catalog.
-
When the sync is complete, your API specification files appear on the Inventory > API catalog page. From there, you can link your API specifications to targets so they can be scanned for vulnerabilities. For more information, refer to Link discovered APIs to targets.
IBM API Connect is now integrated with Invicti Platform. After the initial synchronization, the integration automatically syncs your API specifications every 24 hours.
To synchronize API specifications on demand, click the sync icon on the Discovery > API sources page. To turn off automatic synchronization, click the toggle in the Auto sync column.
Troubleshooting
The sync completes but no APIs appear in my API catalog
Check that the credentials you entered have read access to the published API definitions in IBM API Connect. You can also check the last error message on the Discovery > API sources page — the error details shown there can help identify what went wrong on the connection or import side.
Authentication fails when saving the source configuration
Verify that the Platform API endpoint, Client ID, Client secret, and API key match the values from IBM API Connect. If the issue persists, regenerate the credentials in IBM API Connect and update the source configuration in Invicti.
Need help?
Invicti Support team is ready to provide you with technical help. Go to Help Center