API Service Graph Connector for Kong Gateway

Release version: Xanadu

Updated October 16, 2025

2 minutes to read

Summarize

Summarized using AI

Summary of API Service Graph Connector for Kong Gateway

The ServiceNow® API Service Graph Connector for Kong Gateway enables you to import detailed API information from a Kong Gateway application into the Configuration Management Database (CMDB). This integration supports maintaining a comprehensive and normalized inventory of APIs, enhancing visibility, governance, and collaboration across your API environment without needing direct Kong Gateway access.

Show full answer Show less

Key Features

Imports API data into a normalized data model for consistency with other technologies.
Provides the API Insights workspace, a centralized interface to analyze and interact with API data.
Supports multiple ServiceNow versions, including Washington DC, Xanadu, and Yokohama.
Enables connection configuration and lifecycle management through the SGC Central view in the CMDB Workspace.
Allows integration with Prometheus to import Kong Gateway metrics using the Prometheus plugin.

Use Cases

Maintain an end-to-end inventory of both exposed and backend APIs, tracking published APIs and their consumers.
Trace APIs from customer-facing endpoints to backend services to identify impacts from service changes or failures and facilitate incident creation.
Manage vulnerabilities, security incidents, and compliance requirements related to API endpoints.

Configuration and Data Mapping

Configure the connector via the SGC Central view, which simplifies discovery, installation, and management of connections. During setup, you can optionally link a Prometheus connection for metric imports.

Data from Kong Gateway is mapped and transformed into CMDB Configuration Item (CI) 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 current.

The connector processes multiple data sources—such as Kong Gateway, Workspaces, Load Balancers, Targets, Services, Routes, Consumers, and Plugins—mapping each to corresponding CMDB or non-CMDB tables for comprehensive API representation.

ServiceNow customers can use the IntegrationHub ETL app to view and manage these data mappings, facilitating transparency and customization of data integration workflows.

Use the ServiceNow® API Service Graph Connector for Kong Gateway to import API details from a Kong Gateway 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 Kong Gateway, enhancing visibility, governance, and collaboration across the API estate. To learn more, see API Insights.

Supported ServiceNow versions

Washington DC
Xanadu
Yokohama

Use cases

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

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.

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 SGC Central 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 Kong Gateway using SGC Central.

Note:

You can also include a Prometheus connection and map it to the Kong Gateway connection during setup for importing Kong Gateway metrics data using the Prometheus plugin. To learn more about the Prometheus plugin, see Prometheus on the Kong Developer documentation site.

Data mapping

Data from the Kong 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).

When you complete setting up the connection, you can configure the integration to periodically pull data from a Kong Gateway application.

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 a Kong Gateway application.

Table 1. Data mapping for Kong Gateway
Data source	Staging table	Target tables
SG-Kong Gateway	SG-Kong Gateway [sn_kong_integ_sg_kong_gateway]	Kong Gateway
SG-Kong Workspaces	SG-Kong Workspaces [sn_kong_integ_sg_kong_workspaces]	Kong Workspace
SG-Kong Load Balancers	SG-Kong Load Balancers [sn_kong_integ_sg_kong_lbs]	Kong Load Balancer
SG-Kong Targets	SG-Kong Targets [sn_kong_integ_sg_kong_targets]	Kong Target Key Value
SG-Kong Services	SG-Kong Services [sn_kong_integ_sg_kong_services]	Managed API API Backend Key Value
SG-Kong Routes	SG-Kong Routes [sn_kong_integ_sg_kong_routes]	API Frontend
SG-Kong Consumers	SG-Kong Consumers [sn_kong_integ_sg_kong_consumers]	API Consumer
SG-Kong Plugins	SG-Kong Plugins [sn_kong_integ_sg_kong_plugins]	API Policy

For more information on where data is saved when pulling data from a Kong Gateway application, see Target tables for storing API Service Graph Connector for Kong Gateway data.

You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.