Target tables for storing API Service Graph Connector for Kong Konnect data
Summarize
Summary of Target tables for storing API Service Graph Connector for Kong Konnect data
This document outlines the configuration of target tables used to store data from the API Service Graph Connector for Kong Konnect. The integration allows for periodic data pulls from Kong Konnect applications, with the data being stored in tables extending from Configuration item classes and other non-CMDB tables.
Show less
Key Features
- Kong Gateway [cmdbcikonggateway]: Collects attributes such as ID, Name, Asset Tag, Correlation ID, Description, and Operational Status.
- Kong Data Plane Node [snkongkonnectkongdataplanenode]: Attributes include Hostname, Version, ID, Connection Alias, and Operational Status.
- Cloud Service Account [cmdbcicloudserviceaccount]: Stores Account ID, Name, Datacenter Type, and Operational Status.
- Logical Datacenter [cmdbcilogicaldatacenter]: Holds Name, Object ID, Region, and Operational Status.
- Kong Load Balancer [cmdbcikonglb]: Captures ID, Name, Algorithm, Description, and Operational Status.
- Kong Target [cmdbcikongtarget]: Includes ID, Description, Name, Operational Status, and Target attributes.
- Managed API [cmdbcimanagedapi]: Contains ID, Name, Base URL, Description, Operational Status, Life Cycle Stage Status, and Type.
- API Backend [cmdbciapibackend]: Records Host, Path, URL, Name, Port, and Protocol attributes.
- API Frontend [cmdbciapifrontend]: Gathers Host, Method, Path, URL, Description, Name, Operational Status, and Protocol attributes.
- API Consumer [apiconsumer]: Captures ID, Custom ID, Email, and Username attributes.
- API Consumer Subscription [apiconsumersubscription]: Includes Operational Status, API Consumer ID, Creation Date, Description, and Last Modified Date.
- API Policy [apipolicy]: Stores Name, Managed API ID, Protocols, Frontend, Active status, and Consumer attributes.
- Key Value [cmdbkeyvalue]: Comprises Tag, Configuration Item, Key, and Value attributes.
Key Outcomes
By utilizing these tables, ServiceNow customers can efficiently manage and analyze API-related data from Kong Konnect. This structured data storage enhances visibility into API performance and governance, supporting better operational management and decision-making.
When you complete setting up the connection, you can configure the integration to periodically pull data from a Kong Konnect application. The data is saved in tables that extend from the Configuration item [cmdb_ci] classes and other non-CMDB tables.
Kong Gateway [cmdb_ci_kong_gateway]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Name | name |
| Asset tag | asset_tag |
| Correlation ID | correlation_id |
| Description | short_description |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| Kong Gateway [cmdb_ci_kong_gateway] | Provides::Provided by | Kong Load Balancer [cmdb_ci_kong_lb] |
| Kong Gateway [cmdb_ci_kong_gateway] | Provides::Provided by | Managed API [cmdb_ci_managed_api] |
| Kong Gateway [cmdb_ci_kong_gateway] | Uses::Used by | DNS Alias [cmdb_ci_dns_alias] |
| Kong Gateway [cmdb_ci_kong_gateway] | Reference | Key Value [cmdb_key_value] |
| Kong Gateway [cmdb_ci_kong_gateway] | Reference | API Consumer [api_consumer] |
Kong Data Plane Node [sn_kong_konnect_kong_data_plane_node]
| Attribute label | Attribute name |
|---|---|
| Hostname | hostname |
| Version | version |
| id | ID |
| Connection Alias SysId | connectionaliassysid |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| Kong Data Plane Node [sn_kong_konnect_kong_data_plane_node] | Reference | Kong Gateway [cmdb_ci_kong_gateway] |
Cloud Service Account [cmdb_ci_cloud_service_account]
| Attribute label | Attribute name |
|---|---|
| Account Id | account_id |
| Name | name |
| Datacenter Type | datacenter_type |
| Operational status | operational_status |
Logical Datacenter [cmdb_ci_logical_datacenter]
| Attribute label | Attribute name |
|---|---|
| Name | name |
| Object ID | object_id |
| Region | region |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| Logical Datacenter [cmdb_ci_logical_datacenter] | Hosted on::Hosts | Kong Gateway [cmdb_ci_kong_gateway] |
| Logical Datacenter [cmdb_ci_logical_datacenter] | Hosted on::Hosts | Cloud Service Account [cmdb_ci_cloud_service_account] |
DNS Alias [cmdb_ci_dns_alias]
| Attribute label | Attribute name |
|---|---|
| Name | name |
| Operational status | operational_status |
Kong Load Balancer [cmdb_ci_kong_lb]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Name | name |
| Algorithm | algorithm |
| Description | short_description |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| Kong Load Balancer [cmdb_ci_kong_lb] | Contains::Contained by | Kong Target [cmdb_ci_kong_target] |
Kong Target [cmdb_ci_kong_target]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Description | short_description |
| Name | name |
| Operational status | operational_status |
| Target | target |
Managed API [cmdb_ci_managed_api]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Name | name |
| Base URL | base_url |
| Description | short_description |
| Operational status | operational_status |
| Life Cycle Stage Status | life_cycle_stage_status |
| Life Cycle Stage | life_cycle_stage |
| Type | type |
| Parent class | Relationship type | Child class |
|---|---|---|
| Managed API [cmdb_ci_managed_api] | Uses::Used by | API Frontend [cmdb_ci_api_frontend] |
| Managed API [cmdb_ci_managed_api] | Uses::Used by | API Backend [cmdb_ci_api_backend] |
API Backend [cmdb_ci_api_backend]
| Attribute label | Attribute name |
|---|---|
| Host | host |
| ID | id |
| Path | path |
| URL | url |
| Name | name |
| Port | port |
| Protocol | protocol |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Backend [cmdb_ci_api_backend] | Uses::Used by | Kong Load Balancer [cmdb_ci_kong_lb] |
API Frontend [cmdb_ci_api_frontend]
| Attribute label | Attribute name |
|---|---|
| Host | host |
| ID | id |
| Method | method |
| Path | path |
| URL | url |
| Description | short_description |
| Name | name |
| Operational status | operational_status |
| Protocol | protocol |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Frontend [cmdb_ci_api_frontend] | Use End Point To::Use End Point From | API Backend [cmdb_ci_api_backend] |
API Consumer [api_consumer]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Custom ID | custom_id |
| Email Note: Fetched using the Developers data source only. |
|
| Username | username |
| API Gateway | api_gateway |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Consumer [api_consumer] | Reference | Kong Gateway [cmdb_ci_kong_gateway] |
API Consumer Subscription [cmdb_ci_api_consumer_subscription]
| Attribute label | Attribute name |
|---|---|
| Operational status | operational_status |
| API Consumer | api_consumer |
| ID | id |
| Creation Date | creation_date |
| Description | short_description |
| Last Modified Date | last_modified_date |
| Name | name |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Gateway [cmdb_ci_api_gateway] | Provides::Provided by | API Consumer Subscription [cmdb_ci_api_consumer_subscription] |
API Consumer Access [api_consumer_access]
| Attribute label | Attribute name |
|---|---|
| API | api |
| API Consumer | api_consumer |
| State | state |
| API Consumer Subscription | api_consumer_subscription |
API Policy [api_policy]
| Attribute label | Attribute name |
|---|---|
| Name | name |
| Managed API | managed_api |
| ID | id |
| Protocols | protocols |
| Frontend | frontend |
| Active | active |
| Consumer | consumer |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Policy [api_policy] | Reference | Managed API [cmdb_ci_managed_api] |
Key Value [cmdb_key_value]
| Attribute label | Attribute name |
|---|---|
| Tag | tag |
| Configuration item | configuration_item |
| Key | key |
| Value | value |