API Service Graph Connector for Kong Konnect
Summarize
Summary of API Service Graph Connector for Kong Konnect
The ServiceNow® API Service Graph Connector for Kong Konnect allows customers to import API details from Kong Konnect into the Configuration Management Database (CMDB). This integration enhances visibility and governance of API data, facilitating better collaboration and management of API inventories.
Show less
Key Features
- Data import into a normalized model for consistency across technologies.
- API Insights workspace for centralized analysis and interaction with API data.
- Support for ServiceNow versions: Xanadu, Yokohama, and Zurich.
Use Cases
With this connector, you can:
- Maintain an inventory of APIs, tracking their usage and publication status.
- Monitor APIs from endpoints to underlying services, identifying impacts from service changes or failures.
- Address vulnerabilities and compliance requirements related to APIs.
Configuration
Connections can be configured using the SGC Central view within the CMDB Workspace, which helps in managing the lifecycle of connections effectively. For detailed configuration steps, refer to the guide on setting up the API Service Graph Connector.
Data Mapping
Data from Kong Konnect is transformed and inserted into CMDB using the Robust Transform Engine (RTE) and the Identification and Reconciliation Engine (IRE). The data mapping process involves staging tables and target tables corresponding to various API components.
Record Management
The connector supports soft deletion for CMDB CI classes, marking records as Non-Operational if not discovered during the last scheduled job run, rather than permanently removing them.
Use the ServiceNow® API Service Graph Connector for Kong Konnect to import API details from a Kong Konnect 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 Kong Konnect, enhancing visibility, governance, and collaboration across the API estate. To learn more, see API Insights.
Supported ServiceNow versions
- Xanadu
- Yokohama
- Zurich
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 Kong Konnect using SGC Central.
Data mapping
Data from the Kong Konnect 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 Konnect service.
| Data source | Staging table | Target tables |
|---|---|---|
| Gateway | Gateway [sn_kong_konnect_gateway] | Kong Gateway |
| Data Plane Node | Data Plane Node [sn_kong_konnect_data_plane_node] | Kong Data Plane Node |
| Load Balancer | Load Balancer [sn_kong_konnect_load_balancer] | Kong Load Balancer |
| Target | Target [sn_kong_konnect_target] | Kong Target |
| Services | Services [sn_kong_konnect_services] | Managed API |
| Routes | Routes [sn_kong_konnect_routes] | API Frontend |
| Consumer | Consumer [sn_kong_konnect_consumer] | API Consumer |
| Policy | Policy [sn_kong_konnect_policy] | API Policy |
| Developers | Developers [sn_kong_konnect_developers] | API Consumer |
| Applications | Applications [sn_kong_konnect_applications] | API Consumer Subscription |
| API Consumer Access | API Consumer Access [sn_kong_konnect_api_consumer_access] | API Consumer Access |
For more information on where data is saved when pulling data from a Kong Konnect service, see Target tables for storing API Service Graph Connector for Kong Konnect 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.