API Service Graph Connector for MuleSoft
Summarize
Summary of API Service Graph Connector for MuleSoft
The ServiceNow API Service Graph Connector for MuleSoft enables customers to import and normalize API details from MuleSoft Anypoint Platform applications into the ServiceNow Configuration Management Database (CMDB). This integration supports enhanced visibility, governance, and collaboration across your API landscape by centralizing API data within ServiceNow.
Show less
Compatible with Yokohama, Zurich, and Australia versions of ServiceNow, this connector facilitates comprehensive API management without requiring direct access to MuleSoft environments.
Key Features
- Imports MuleSoft API details into a normalized CMDB data model, ensuring consistency across technologies.
- Provides the API Insights workspace, a centralized interface to analyze and interact with API data for improved governance and collaboration.
- Supports lifecycle management of the connector connection via the SGC Central view within the CMDB Workspace, enabling discovery, installation, monitoring, and debugging.
- Utilizes Robust Transform Engine (RTE) and Identification and Reconciliation Engine (IRE) to map, transform, and reconcile MuleSoft data into CMDB Configuration Item (CI) classes.
- Enables scheduled periodic data pulls from MuleSoft to keep API details current in the CMDB.
Use Cases
- Maintain an end-to-end inventory of published and backend APIs, including usage and ownership details.
- Create relationships between API managers, runtime deployments, and gateway instances to understand dependencies and impacts.
- Track managed APIs across multiple MuleSoft organizations and environments, including operational status and deployment details.
- Support security and compliance by addressing vulnerabilities and incidents related to API endpoints.
- Enable proactive incident management by identifying impacted endpoints when backend services change or fail, reducing resolution times.
Configuring the Connector
Use the SGC Central view in the CMDB Workspace to discover, install, and configure the API Service Graph Connector for MuleSoft. This interface facilitates connection lifecycle management, including editing, monitoring, and debugging.
Data Mapping and Integration
MuleSoft data sources are mapped and transformed into CMDB CI classes through the Robust Transform Engine and inserted using the Identification and Reconciliation Engine. Key data sources include Gateways, Managed APIs, Frontend and Backend APIs, and API Deployments.
The connector stores data in specific staging and target tables aligned with MuleSoft data structures, allowing detailed API modeling within the CMDB. Customers can use the IntegrationHub ETL application to view and manage data mappings.
Use the ServiceNow® API Service Graph Connector for MuleSoft to import API details from a MuleSoft Anypoint Platform application into the Configuration Management Database (CMDB).
Request apps on the Store
Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Key features
Import data into a normalized data model for consistency across other technologies.
The API Insights workspace provides a centralized interface where you can analyze and interact with API data, without needing direct access to a MuleSoft Anypoint Platform application, enhancing visibility, governance, and collaboration across the API estate. To learn more, see API Insights.
Supported ServiceNow versions
- Yokohama
- Zurich
- Australia
Use cases
- Maintain an end-to-end inventory of exposed and backend APIs, identifying what APIs are published, used, and by whom.
- Create relationships between API managers, runtime deployments, and gateway instances to understand service dependencies and identify impact when services change or fail.
- Track all managed APIs across multiple MuleSoft organizations and environments, identifying which APIs are active, deployed, and their operational status.
- Address vulnerabilities and security incidents related to API endpoints and create compliance requirements.
- Identify impacted endpoints when backend services change or fail, enabling proactive incident management and faster resolution times.
Configuring a connection for the connector
You can configure a connection for the connector by using the SGC Central view in the CMDB Workspace. The SGC Central view enables you to discover and install connectors, and then effectively manage the full life cycle of creating, editing, monitoring, and debugging connections. To configure the connector using SGC Central, see Configure API Service Graph Connector for MuleSoft using SGC Central.
Data mapping
Data from the MuleSoft Anypoint Platform data sources is mapped and transformed into the CMDB Configuration Item (CI) class definitions using the Robust Transform Engine (RTE). Data is inserted into the CMDB using the Identification and Reconciliation Engine (IRE).
When you complete setting up the connection, you can configure the integration to periodically pull data from a MuleSoft Anypoint Platform application.
| Data source | Staging table | Target tables |
|---|---|---|
| Gateway | Gateway [sn_mulesoft_gateway] | Anypoint API Gateway |
| API Manager | Managed API [sn_mulesoft_managed_api] | Managed API |
| Frontend And Backend | Frontend And Backend [sn_mulesoft_frontend_and_backend] | Frontend |
| API Deployments | API Deployments [sn_mulesoft_api_deployments] | API Deployment |
For more information on where data is saved when pulling data from a MuleSoft Anypoint Platform application, see Target tables for storing API Service Graph Connector for MuleSoft data.
You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.