API Service Graph Connector for AWS API Gateway
Summarize
Summary of API Service Graph Connector for AWS API Gateway
The ServiceNow API Service Graph Connector for AWS API Gateway enables customers to import detailed API information from AWS API Gateway services directly into the Configuration Management Database (CMDB). This integration supports improved visibility, governance, and management of APIs within your enterprise environment.
Show less
Key Features
- Imports API data into a normalized data model ensuring consistency across different technologies.
- Provides the API Insights workspace, a centralized interface to analyze and interact with API data without requiring direct AWS API Gateway access.
- Supports ServiceNow versions Yokohama, Zurich, and Australia.
Use Cases
- Maintains an end-to-end inventory of APIs, identifying published APIs, their usage, and stakeholders.
- Tracks APIs from customer-facing endpoints to backend services, helping to identify impacted endpoints during service disruptions and facilitating incident creation.
- Addresses API endpoint vulnerabilities and security incidents while supporting compliance through measurable requirements.
Configuring the Connector
Configuration is done via the SGC Central view in the CMDB Workspace, which allows discovery, installation, and lifecycle management of connectors including creation, editing, monitoring, and debugging connections. Customers can follow specific guidance for configuration using SGC Central.
Data Mapping and Integration
Data extracted from AWS API Gateway sources is mapped and transformed into CMDB Configuration Item classes using the Robust Transform Engine (RTE) and inserted using the Identification and Reconciliation Engine (IRE). Multiple data sources correspond to various staging and target CMDB tables, capturing elements such as managed APIs, DNS aliases, keys, frontend/backend APIs, deployments, consumers, policies, and access details.
The integration can be configured for periodic data pulls to keep CMDB information current. The IntegrationHub ETL app can be used to view and manage data mappings.
Record Removal Process
The connector employs soft deletion exclusively for CMDB CI records, marking records as Non-Operational if they are no longer discovered during scheduled jobs, rather than permanently deleting them. This approach ensures historical data integrity while reflecting current API states.
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.