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 guide details the target tables that store data collected from the Kong Konnect application through the API Service Graph Connector. The integration enables ServiceNow customers to periodically pull data into their system for effective management and analysis.
Show less
Key Features
- Kong Gateway [cmdbcikonggateway]: Stores essential attributes like ID, Name, Asset Tag, and Operational Status, creating relationships with other components such as Kong Load Balancer, Managed API, and DNS Alias.
- Kong Data Plane Node [snkongkonnectkongdataplanenode]: Captures details including Hostname and Version, with a reference relationship to Kong Gateway.
- Cloud Service Account [cmdbcicloudserviceaccount]: Contains attribute fields for Account ID and Datacenter Type, linking to Logical Datacenter and Kong Gateway.
- Managed API [cmdbcimanagedapi]: Holds data like ID, Name, and Base URL, with relationships to API Frontend and API Backend.
- API Consumer [apiconsumer]: Includes attributes such as Custom ID and Email, vital for managing consumer interactions.
- API Policy [apipolicy]: Manages policies associated with Managed APIs, detailing protocols and consumer references.
Key Outcomes
By utilizing these target tables, ServiceNow customers can effectively manage their API infrastructure, ensuring that they have a comprehensive view of their services and relationships. This integration enhances operational efficiency, improves data accuracy, and supports better decision-making through consolidated data management.
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 |