API Service Graph Connector for Apigee X
Summarize
Summary of API Service Graph Connector for Apigee X
The API Service Graph Connector for Apigee X enables ServiceNow customers to import API proxy details from Apigee X applications directly into the Configuration Management Database (CMDB). This integration supports maintaining a comprehensive, normalized inventory of APIs, improving visibility and governance across API environments without requiring direct access to Apigee X.
Show less
This connector is compatible with ServiceNow versions Xanadu, Yokohama, and Zurich, and provides enhanced API management capabilities through the API Insights workspace.
Key Features
- Imports API data into a normalized data model, ensuring consistency across different technologies.
- Provides a centralized API Insights workspace for analyzing and interacting with API data.
- Supports continuous data synchronization by periodically pulling API details from Apigee X applications.
- Facilitates end-to-end API inventory management, tracking from customer-facing endpoints to backend services.
- Enables tracking of API usage, security vulnerabilities, and compliance by creating incidents and compliance requirements.
- Soft deletion of CMDB Configuration Item (CI) records ensures non-discovered records are marked as Non-Operational rather than permanently deleted.
Configuration and Data Management
Connections for the connector are configured via the SGC Central view within the CMDB Workspace, allowing discovery, installation, and lifecycle management of connectors including creation, monitoring, and debugging.
The connector uses the Robust Transform Engine (RTE) to map and transform data from Apigee X sources into CMDB CI classes, and the Identification and Reconciliation Engine (IRE) to insert data into the CMDB.
Data sources such as Apigee Organization, Managed API, API Consumer, Frontend/Backend, API Product, and related Google Cloud Platform organizational structures are staged and mapped to specific CMDB and non-CMDB tables to maintain detailed and organized API records.
ServiceNow’s IntegrationHub ETL app can be used to view and manage these data maps.
Upgrade Considerations
Existing customers using production instances should contact Now Support before upgrading to version 2.3.0 of the connector. This upgrade modifies source native keys that could impact records in the Source [sysobjectsource] table and may cause duplicate records if not coordinated properly.
Practical Benefits
- Helps ServiceNow customers maintain an accurate, up-to-date API inventory integrated within their CMDB.
- Improves incident management by linking API endpoints to backend services, enabling impact analysis and faster issue resolution.
- Enhances security posture by allowing tracking and management of API vulnerabilities and compliance requirements.
- Supports governance and collaboration through a centralized API Insights workspace without requiring direct Apigee X access.
Use the ServiceNow® API Service Graph Connector for Apigee X to import API proxy details from an Apigee X 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 Apigee X, 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.
- Track APIs from customer-facing endpoints to the underlying services, identifying impacted endpoints when services change or fail and creating incidents for reported issues.
- Address vulnerabilities and security incidents related to API endpoints, and create compliance requirements to measure against.
Important information for upgrading API Service Graph Connector for Apigee X
If you’re an existing customer using production instances, reach out to Now Support before upgrading to API Service Graph Connector for Apigee X v2.3.0. This upgrade alters source native keys that can impact Source [sys_object_source] table records. Coordinating with Now Support helps to prevent duplicate record creation.
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 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 Apigee X using SGC Central.
Data mapping
Data from the Apigee X 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 an Apigee X application.
| Data source | Staging table | Target tables |
|---|---|---|
| Apigee Organization | SGA Apigee X Apigee Organization [sn_apigee_x_apigee_organization] | Google Organization Project |
| Managed API | SGA Apigee X Managed API [sn_apigee_x_sga_apigee_x_managed_api] | Managed API |
| API Consumer | SGA Apigee X API Consumer [sn_apigee_x_sga_apigee_x_api_consumer] | API Consumer |
| API Frontend Backend | SGA Apigee X Frontend Backend [sn_apigee_x_sga_apigee_x_frontend_backend] | API Frontend |
| API Product | SGA Apigee X API Product [sn_apigee_x_sga_apigee_x_api_product] | API Product Bundle |
| API Consumer Subscription | SGA Apigee X API Consumer Subscription [sn_apigee_x_sga_apigee_x_api_consumer_subscription] | API Consumer Subscription |
| API Consumer Access | SGA Apigee X API Consumer Access [sn_apigee_x_sga_apigee_x_api_consumer_access] | API Consumer Access |
| GCP Organization | SGA Apigee X Organization [sn_apigee_x_sga_apigee_x_organization] | |
| GCP Folder | SGA Apigee X Folder [sn_apigee_x_sga_apigee_x_folder] | Google Organization Folder |
| GCP Project | SGA Apigee X Project [sn_apigee_x_sga_apigee_x_project] | Google Organization Project |
For more information on where data is saved when pulling data from an Apigee X application, see Target tables for storing API Service Graph Connector for Apigee X data.
You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.
Record removal process
The connector supports soft deletion for CMDB CI classes only, meaning records aren’t permanently removed from the system. Instead, any CMDB CI records not discovered during the last scheduled job run are marked as Non-Operational.