API Service Graph Connector for AWS API Gateway

concept australia Updated Sep 10, 2026 3 min read api-sgc-aws-gateway.md
Raw file servicenow.com

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 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

You can use the API Service Graph Connector for AWS API Gateway to:

  • 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).

The following table lists the data sources in the order they run, the staging tables, and the target tables as CMDB CI and non-CMDB classes for an AWS API Gateway service.

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 GatewayDNS Alias

Managed API

Key Value

Managed API V2

SGA-AWS Managed API V2 [sn_aws_api_gw_int_sga_aws_managed_api_v2]

Managed APIAWS API Gateway

DNS Alias

Key Value

Frontend Backend REST

SGA-AWS Frontend-Backend REST [sn_aws_api_gw_int_sga_aws_frontend_backend_rest]

API BackendAPI Frontend

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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/api-sgc-aws-gateway-tables.md).

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.

Search documentation
Search document titles and file paths on the australia branch