API Service Graph Connector for Kong Gateway
Summarize
Summary of API Service Graph Connector for Kong Gateway
The ServiceNow API Service Graph Connector for Kong Gateway enables customers to import detailed API information from Kong Gateway applications directly into the Configuration Management Database (CMDB). This integration helps maintain a comprehensive and normalized inventory of APIs, supporting improved visibility, governance, and operational management across the API landscape.
Show less
Key Features
- Normalized Data Model: Imports Kong Gateway API data into a standardized CMDB model to ensure consistency across multiple technologies.
- API Insights Workspace: Provides a centralized interface within ServiceNow to analyze and interact with API data without requiring direct access to Kong Gateway, enhancing collaboration and governance.
- Supported Versions: Compatible with ServiceNow Yokohama, Zurich, and Australia releases.
Use Cases
- Maintaining an end-to-end inventory of published and backend APIs, along with usage tracking and ownership identification.
- Mapping APIs from customer-facing endpoints to underlying backend services to identify impacted endpoints during changes or failures and facilitate incident creation.
- Addressing security vulnerabilities and compliance requirements related to API endpoints.
Configuration and Data Management
Customers configure the connector using the SGC Central view within the CMDB Workspace, which streamlines discovery, installation, lifecycle management, and troubleshooting of connections.
During setup, it is possible to include a Prometheus connection to import Kong Gateway metrics data via the Prometheus plugin, enhancing monitoring capabilities.
Data from Kong Gateway is mapped and transformed into CMDB Configuration Item (CI) classes using the Robust Transform Engine (RTE) and inserted using the Identification and Reconciliation Engine (IRE). Data is periodically pulled from Kong Gateway applications to keep the CMDB updated.
The connector processes multiple data sources—such as Kong Gateway, Workspaces, Load Balancers, Targets, Services, Routes, Consumers, and Plugins—storing them into specific staging and target tables within the CMDB for comprehensive API service graph representation.
ServiceNow customers can also use the IntegrationHub ETL application to view and manage data mappings for the connector.
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.