API Service Graph Connector for Kong Gateway
Summarize
Summary of API Service Graph Connector for Kong Gateway
The API Service Graph Connector for Kong Gateway enables ServiceNow customers to import API details from a Kong Gateway application into the Configuration Management Database (CMDB). This integration supports enhanced API visibility, governance, and collaboration by normalizing API data and providing centralized analysis through the API Insights workspace. It supports ServiceNow versions Yokohama, Zurich, and Australia.
Show less
Key Features
- Imports API data into a normalized data model to ensure consistency across technologies.
- Provides the API Insights workspace, a centralized interface for analyzing and interacting with API data without requiring direct access to Kong Gateway.
- Supports tracking of APIs from customer-facing endpoints to backend services to identify usage and impacted endpoints.
- Facilitates vulnerability and security incident management related to API endpoints along with compliance requirement creation.
Usage and Use Cases
- Maintain an end-to-end inventory of published and used APIs, including identifying consumers.
- Track dependencies between APIs and backend services to quickly identify and manage service impacts and incident creation.
- Address security vulnerabilities and compliance needs for API endpoints effectively.
Configuration
Connections for the connector are configured via the SGC Central view within the CMDB Workspace, which manages the full lifecycle of connector setup, editing, monitoring, and debugging. During setup, you can optionally include a Prometheus connection to import Kong Gateway metrics using the Prometheus plugin.
Data Mapping and Integration
Data from Kong Gateway is mapped into the CMDB using the Robust Transform Engine (RTE) and inserted with the Identification and Reconciliation Engine (IRE). The connector pulls and updates data periodically from Kong Gateway, populating specific CMDB Configuration Item (CI) classes and related tables such as:
- Kong Gateway
- Kong Workspaces
- Kong Load Balancers
- Kong Targets
- Kong Services (Managed API Backends)
- Kong Routes (API Frontends)
- Kong Consumers (API Consumers)
- Kong Plugins (API Policies)
ServiceNow customers can review and customize data mappings using the IntegrationHub ETL application to tailor the integration to their environment.
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
- 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.
Configuring a connection for the connector
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.
| Data source | Staging table | Target tables |
|---|---|---|
| SG-Kong Gateway | SG-Kong Gateway [sn_kong_integ_sg_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 |
| SG-Kong Services | SG-Kong Services [sn_kong_integ_sg_kong_services] | Managed API |
| 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.