API Service Graph Connector for Apigee X
Summarize
Summary of API Service Graph Connector for Apigee X
The ServiceNow® API Service Graph Connector for Apigee X enables customers to import API proxy details from Apigee X applications into the Configuration Management Database (CMDB). This integration helps maintain a comprehensive and normalized inventory of APIs, improving visibility, governance, and collaboration across the API estate without requiring direct access to Apigee X.
Show less
Key Features
- Normalized Data Model: Imports data into a standardized structure to maintain consistency across various technologies.
- API Insights Workspace: Provides a centralized interface for analyzing and interacting with API data, enhancing operational insight and governance.
- Supported Versions: Compatible with ServiceNow Yokohama, Zurich, and Australia releases.
Use Cases
- Maintain a detailed inventory of exposed and backend APIs, including usage and ownership information.
- Trace APIs from customer-facing endpoints through to underlying services to identify impacted endpoints and facilitate incident management.
- Manage vulnerabilities and security incidents related to API endpoints and enforce compliance requirements.
Configuration and Data Management
Connections for the connector are configured via the SGC Central view in the CMDB Workspace, which supports discovery, installation, and lifecycle management of connectors including monitoring and debugging.
Data from Apigee X is mapped and transformed into CMDB Configuration Item classes using the Robust Transform Engine (RTE) and inserted via the Identification and Reconciliation Engine (IRE). The integration supports scheduled data pulls to keep the CMDB updated.
Key data sources include Apigee Organization, Managed API, API Consumer, Frontend Backend, API Product, Consumer Subscription, Consumer Access, and Google Cloud Platform (GCP) organization structures. These are stored in specific staging and target CMDB tables to maintain organized and accessible API information.
Important Upgrade Information
Customers using production instances should contact Now Support before upgrading to version 2.3.0, as this update changes source native keys affecting the Source table and may result in duplicate records if not coordinated properly.
Record Removal Process
The connector implements soft deletion for CMDB CI records. Records not discovered during the latest scheduled data import are marked as Non-Operational instead of being permanently deleted, preserving historical data integrity.
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
- 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.
- 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.