API Service Graph Connector for AWS API Gateway
Summarize
Summary of API Service Graph Connector for AWS API Gateway
The API Service Graph Connector for AWS API Gateway enables ServiceNow customers to import and manage API details from AWS API Gateway within the ServiceNow Configuration Management Database (CMDB). This integration supports a normalized data model for consistent API data representation, enhancing visibility, governance, and collaboration across your API landscape through the API Insights workspace.
Show less
This connector is compatible with ServiceNow versions Yokohama, Zurich, and Australia.
Key features
- Imports AWS API Gateway data into a standardized CMDB data model.
- Provides a centralized interface (API Insights workspace) for analyzing and interacting with API data without direct AWS API Gateway access.
- Supports lifecycle management of API connections via the SGC Central view in the CMDB Workspace, enabling discovery, installation, and monitoring of connectors.
- Utilizes ServiceNow’s Robust Transform Engine (RTE) and Identification and Reconciliation Engine (IRE) to map and reconcile AWS API Gateway data into CMDB classes.
- Supports periodic data pulls and soft deletion of CMDB records—marking undiscovered records as Non-Operational instead of permanent removal.
Use cases
- Maintain an up-to-date, end-to-end inventory of APIs including published APIs, usage, and ownership.
- Trace APIs from customer-facing endpoints to backend services, enabling impact analysis and incident creation when service issues occur.
- Manage API-related vulnerabilities and security incidents, and enforce compliance requirements.
Configuration and data management
Configuration of the connector is done through the SGC Central view in the CMDB Workspace, which supports creating, editing, and monitoring connector connections.
Data from AWS API Gateway is ingested in stages, mapped from various AWS data sources into corresponding CMDB and non-CMDB classes. Examples include Managed APIs, Frontend and Backend APIs, Deployments, Consumers, and Policies. The IntegrationHub ETL app can be used to view and manage these data maps.
Data handling and record lifecycle
Imported CMDB Configuration Items (CIs) are maintained using soft deletion, where CIs not rediscovered during scheduled imports are marked as Non-Operational rather than being deleted. This preserves historical data and supports accurate lifecycle tracking.
Use the ServiceNow® API Service Graph Connector for AWS API Gateway to import API details from an AWS API Gateway service 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 AWS API Gateway, 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 defined 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.
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 AWS API Gateway using SGC Central.
Data mapping
Data from the AWS API Gateway 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).
| Data source | Staging table | Target tables |
|---|---|---|
| Managed API Rest | SGA-AWS Managed API Rest [sn_aws_api_gw_int_api_gateway_managed_api_import_set] | AWS API Gateway |
| Managed API V2 | SGA-AWS Managed API V2 [sn_aws_api_gw_int_sga_aws_managed_api_v2] | Managed API |
| Frontend Backend REST | SGA-AWS Frontend-Backend REST [sn_aws_api_gw_int_sga_aws_frontend_backend_rest] | API Backend |
| Backend V2 | SGA-AWS Backend V2 [sn_aws_api_gw_int_sga_aws_backend_v2] | API Backend |
| Frontend V2 | SGA-AWS Frontend V2 [sn_aws_api_gw_int_sga_aws_frontend_v2] | API Frontend |
| Deployment Rest | SGA-AWS API Gateway Deployment Rest [sn_aws_api_gw_int_sga_aws_api_gateway_deployment_rest] | API Deployment |
| Deployment V2 | SGA-AWS API Gateway Deployment V2 [sn_aws_api_gw_int_sga_aws_api_gateway_deployment_v2] | API Deployment |
| Consumer | SGA-AWS Consumers [sn_aws_api_gw_int_sga_aws_consumers] | API Consumer |
| Policies | SGA-AWS API Gateway Policies [sn_aws_api_gw_int_sga_aws_api_gateway_policies] | API Policy |
| API Consumer Access | SGA-AWS-API-Consumer-Access [sn_aws_api_gw_int_sga_aws_api_consumer_access] | API Consumer Access |
When you complete setting up the connection, you can configure the integration to periodically pull data from an AWS API Gateway service. For information on where data is saved when pulling data from an AWS API Gateway service, see Target tables for storing API Service Graph Connector for AWS API Gateway 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 are not permanently removed from the system. Instead, any CMDB CI records not discovered during the last scheduled job run are marked as Non-Operational.