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 comprehensive API details from MuleSoft Anypoint Platform applications directly into the ServiceNow Configuration Management Database (CMDB). This integration supports enhanced visibility, governance, and collaboration across APIs by normalizing data into a consistent model and centralizing API information within the API Insights workspace.
Show less
The connector is compatible with ServiceNow versions Xanadu, Yokohama, and Zurich, and is designed to provide a unified view of API assets without requiring direct MuleSoft platform access.
Key Features
- Imports API data into a normalized data model within the CMDB for consistent management alongside other technologies.
- API Insights workspace offers a centralized analysis interface to interact with API data, improving governance and collaboration.
- Supports tracking of APIs across multiple MuleSoft organizations and environments, including their deployment status and operational health.
- Enables the creation of relationships among API managers, runtime deployments, and gateway instances to map dependencies and assess impact.
Use Cases
- Maintain an end-to-end inventory of exposed and backend APIs, including who publishes and uses them.
- Understand service dependencies and potential impact from API or backend service changes or failures.
- Track active and deployed APIs across various MuleSoft environments for operational monitoring.
- Address security vulnerabilities and compliance requirements related to API endpoints.
- Proactively manage incidents by identifying affected endpoints when backend services change or fail.
Configuration and Data Management
Customers configure the connector through the SGC Central view in the CMDB Workspace, which facilitates discovery, installation, and lifecycle management of connectors, including monitoring and debugging connections.
Data from MuleSoft Anypoint Platform is ingested using the Robust Transform Engine (RTE) to map it into CMDB Configuration Item (CI) classes and inserted via the Identification and Reconciliation Engine (IRE). The integration can be set up to periodically pull updated data.
The connector organizes data across several key MuleSoft data sources such as Gateway, Managed APIs, Frontend and Backend services, and API Deployments, storing them into corresponding staging and target CMDB tables. Customers can also utilize 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
- Xanadu
- Yokohama
- Zurich
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.